Tasks
Attributes:
| Name | Type | Description |
|---|---|---|
TaskUnion |
|
|
TaskAdapter |
|
TaskUnion = Annotated[
PropertyTask | BatchTask | GeneralTask,
Field(..., discriminator="category"),
]
Bases: BaseAlbertModel
Show JSON schema:
{
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"BlockLevelInventoryInformation": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
},
"IntervalId": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "IntervalId",
"type": "object"
}
},
"properties": {
"id": {
"description": "The ID of the block.",
"title": "Id",
"type": "string"
},
"expand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Expand"
},
"Interval": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalId"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The IDs of the interval (e.g., id: ROW2XROW4)",
"title": "Interval"
},
"Inventory": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockLevelInventoryInformation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventory"
}
},
"required": [
"id"
],
"title": "BlockState",
"type": "object"
}
Fields:
-
id(str) -
expanded(bool | None) -
intervals(list[IntervalId] | None) -
inventory(list[BlockLevelInventoryInformation] | None)
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"BlockLevelInventoryInformation": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
},
"BlockState": {
"properties": {
"id": {
"description": "The ID of the block.",
"title": "Id",
"type": "string"
},
"expand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Expand"
},
"Interval": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalId"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The IDs of the interval (e.g., id: ROW2XROW4)",
"title": "Interval"
},
"Inventory": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockLevelInventoryInformation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventory"
}
},
"required": [
"id"
],
"title": "BlockState",
"type": "object"
},
"IntervalId": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "IntervalId",
"type": "object"
}
},
"properties": {
"leftPanelExpand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Leftpanelexpand"
},
"Block": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockState"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Block"
}
},
"title": "PageState",
"type": "object"
}
Fields:
-
left_panel_expanded(bool | None) -
blocks(list[BlockState] | None)
Bases: BaseAlbertModel
Show JSON schema:
Fields:
-
data_column_unique_id(str | None) -
value(str | None)
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"Target": {
"properties": {
"dataColumnUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datacolumnuniqueid"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "Target",
"type": "object"
}
},
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"targets": {
"items": {
"$ref": "#/$defs/Target"
},
"title": "Targets",
"type": "array"
}
},
"required": [
"id",
"targets"
],
"title": "DataTemplateAndTargets",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
Show JSON schema:
{
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"standardId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"standardOrganization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardorganization"
}
},
"required": [
"id"
],
"title": "Standard",
"type": "object"
}
Fields:
-
id(str) -
standard_id(str | None) -
name(str | None) -
standard_organization(str | None)
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"Standard": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"standardId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"standardOrganization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardorganization"
}
},
"required": [
"id"
],
"title": "Standard",
"type": "object"
},
"Target": {
"properties": {
"dataColumnUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datacolumnuniqueid"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "Target",
"type": "object"
}
},
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Fullname"
},
"Standards": {
"anyOf": [
{
"$ref": "#/$defs/Standard"
},
{
"type": "null"
}
],
"default": null
},
"Targets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Target"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Targets"
}
},
"required": [
"id",
"name"
],
"title": "BlockDataTemplateInfo",
"type": "object"
}
Fields:
Attributes:
| Name | Type | Description |
|---|---|---|
UNCLAIMED |
|
|
NOT_STARTED |
|
|
IN_PROGRESS |
|
|
COMPLETED |
|
|
CLOSED |
|
Bases: BaseAlbertModel
Represents the Inventory information needed for a task. For a Batch task, inventory_id and batch_size are required. For Property and general tasks, inventory_id and lot_id is recomended is required.
Attributes:
| Name | Type | Description |
|---|---|---|
inventory_id |
str
|
The inventory id of the item to be used in the task. |
lot_id |
(str, optional)
|
The lot id of the item to be used in the task. Reccomended for Property and General tasks. |
batch_size |
float, Required for Batch tasks, otherwise optional.
|
The batch size to make of the related InventoryItem. Required for Batch tasks. |
selected_lot |
bool, read only
|
Whether the lot is selected for the task. Default is None. |
Show JSON schema:
{
"description": "Represents the Inventory information needed for a task. For a Batch task, inventory_id and batch_size are required.\nFor Property and general tasks, inventory_id and lot_id is recomended is required.\n\nAttributes\n----------\ninventory_id : str\n The inventory id of the item to be used in the task.\nlot_id : str, optional\n The lot id of the item to be used in the task. Reccomended for Property and General tasks.\nbatch_size : float, Required for Batch tasks, otherwise optional.\n The batch size to make of the related InventoryItem. Required for Batch tasks.\nselected_lot : bool, read only\n Whether the lot is selected for the task. Default is None.",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
},
"batchSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchsize"
},
"selectedLot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Selectedlot"
},
"barcodeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Barcodeid"
},
"quantityUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Quantityused"
}
},
"required": [
"id"
],
"title": "InventoryInformation",
"type": "object"
}
Fields:
-
inventory_id(InventoryId) -
lot_id(LotId | None) -
inv_lot_unique_id(str | None) -
batch_size(float | None) -
selected_lot(bool | None) -
barcode_id(str | None) -
quantity_used(float | None)
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"ACL": {
"description": "The Access Control List (ACL) for a user",
"properties": {
"id": {
"description": "The id of the user for which this ACL applies",
"title": "Id",
"type": "string"
},
"fgc": {
"anyOf": [
{
"$ref": "#/$defs/AccessControlLevel"
},
{
"type": "null"
}
],
"default": null,
"description": "The Fine-Grain Control Level"
}
},
"required": [
"id"
],
"title": "ACL",
"type": "object"
},
"AccessControlLevel": {
"description": "The fine grain control",
"enum": [
"ProjectOwner",
"ProjectEditor",
"ProjectViewer",
"ProjectAllTask",
"ProjectPropertyTask",
"InventoryOwner",
"InventoryViewer",
"CustomTemplateOwner"
],
"title": "AccessControlLevel",
"type": "string"
},
"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"
},
"BlockDataTemplateInfo": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Fullname"
},
"Standards": {
"anyOf": [
{
"$ref": "#/$defs/Standard"
},
{
"type": "null"
}
],
"default": null
},
"Targets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Target"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Targets"
}
},
"required": [
"id",
"name"
],
"title": "BlockDataTemplateInfo",
"type": "object"
},
"Cas": {
"description": "Represents a CAS entity.",
"properties": {
"number": {
"description": "The CAS number.",
"title": "Number",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the CAS.",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description or name of the CAS.",
"title": "Description"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Notes related to the CAS.",
"title": "Notes"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/CasCategory"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of the CAS."
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "CAS SMILES notation.",
"title": "Cassmiles"
},
"inchiKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "InChIKey of the CAS.",
"title": "Inchikey"
},
"iUpacName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "IUPAC name of the CAS.",
"title": "Iupacname"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The AlbertID of the CAS.",
"title": "Albertid"
},
"hazards": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Hazard"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazards associated with the CAS.",
"title": "Hazards"
},
"wgk": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "German Water Hazard Class (WGK) number.",
"title": "Wgk"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "European Community (EC) number.",
"title": "Eclistno"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of the CAS.",
"title": "Type"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Classification type of the CAS.",
"title": "Classificationtype"
},
"order": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "CAS order.",
"title": "Order"
}
},
"required": [
"number"
],
"title": "Cas",
"type": "object"
},
"CasAmount": {
"description": "CasAmount is a Pydantic model representing an amount of a given CAS.\n\nAttributes\n----------\nmin : float\n The minimum amount of the CAS in the formulation.\nmax : float\n The maximum amount of the CAS in the formulation.\nid : str | None\n The Albert ID of the CAS Number Resource this amount represents. Provide either a Cas or an ID.\ncas : Cas | None\n The CAS object associated with this amount. Provide either a Cas or an id.\ncas_smiles: str | None\n The SMILES string of the CAS Number resource. Obtained from the Cas object when provided.\nnumber: str | None\n The CAS number. Obtained from the Cas object when provided.",
"properties": {
"min": {
"title": "Min",
"type": "number"
},
"max": {
"title": "Max",
"type": "number"
},
"inventoryValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventoryvalue"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"casCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cascategory"
},
"cas": {
"anyOf": [
{
"$ref": "#/$defs/Cas"
},
{
"type": "null"
}
],
"default": null
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cassmiles"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
}
},
"required": [
"min",
"max"
],
"title": "CasAmount",
"type": "object"
},
"CasCategory": {
"enum": [
"User",
"Verisk",
"TSCA - Public",
"TSCA - Private",
"not TSCA",
"CAS linked to External Database",
"Unknown (Trade Secret)",
"CL_Inventory Upload"
],
"title": "CasCategory",
"type": "string"
},
"Company": {
"description": "Company is a Pydantic model representing a company entity.\n\nAttributes\n----------\nname : str\n The name of the company.\nid : str | None\n The Albert ID of the company. Set when the company is retrieved from Albert.\ndistance : float | None\n The scores of a company in a search result, optional. Read-only.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"distance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Distance"
}
},
"required": [
"name"
],
"title": "Company",
"type": "object"
},
"DataColumn": {
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"defalt": {
"default": false,
"title": "Defalt",
"type": "boolean"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"albertId": {
"default": null,
"title": "Albertid",
"type": "string"
}
},
"required": [
"name"
],
"title": "DataColumn",
"type": "object"
},
"DataColumnValue": {
"properties": {
"data_column": {
"$ref": "#/$defs/DataColumn",
"default": null
},
"id": {
"default": null,
"title": "Id",
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"hidden": {
"default": false,
"title": "Hidden",
"type": "boolean"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"calculation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Calculation"
},
"sequence": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence"
},
"validation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ValueValidation"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Validation"
}
},
"title": "DataColumnValue",
"type": "object"
},
"DataTemplate": {
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"security_class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"verified": {
"default": false,
"title": "Verified",
"type": "boolean"
},
"ACL": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Acl"
},
"DataColumns": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataColumnValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Datacolumns"
},
"Parameters": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ParameterValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Parameters"
},
"DeletedParameters": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ParameterValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Deletedparameters"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "DataTemplate",
"type": "object"
},
"DataTemplateAndTargets": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"targets": {
"items": {
"$ref": "#/$defs/Target"
},
"title": "Targets",
"type": "array"
}
},
"required": [
"id",
"targets"
],
"title": "DataTemplateAndTargets",
"type": "object"
},
"DataType": {
"enum": [
"number",
"string",
"enum"
],
"title": "DataType",
"type": "string"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"EnumValidationValue": {
"description": "Represents a value for an enum type validation.\n\nAttributes\n----------\ntext : str\n The text of the enum value.\nid : str | None\n The ID of the enum value. If not provided, the ID will be generated upon creation.",
"properties": {
"text": {
"title": "Text",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"originalText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originaltext"
}
},
"required": [
"text"
],
"title": "EnumValidationValue",
"type": "object"
},
"Hazard": {
"description": "Represents a chemical hazard.",
"properties": {
"subCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard subcategory",
"title": "Subcategory"
},
"hCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard code",
"title": "Hcode"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard category",
"title": "Category"
},
"class": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard classification",
"title": "Class"
},
"hCodeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard code text",
"title": "Hcodetext"
}
},
"title": "Hazard",
"type": "object"
},
"Interval": {
"description": "A Pydantic class representing an interval.\n\nAttrubutes\n----------\nvalue : str\n The value of the interval setpoint.\nunit : Unit\n The unit of the related value.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rowid"
}
},
"title": "Interval",
"type": "object"
},
"IntervalCombination": {
"description": "A class representing the interval combinations of on a workflow.\nThis is returned by the workflow endpoint when at least one parameter\nin the workflow has been intervalized.\n\nInterval Combinations can be single intervalized parameters or cartesian prodcuts of\ntwo intervalized parameters.\n\nAttributes\n----------\ninterval_id: IntervalId | None\n forign key reference to the interval id\n this combination is associated with\n It will have the form ROW# or ROW#XROW# depending on\n if it is a single interval or a product of two intervals\ninterval_params: str | None\n The parameters participating in the interval.\ninterval_string: str | None\n The string representation of the interval combination\n This will have the form \"[Parameter Name]: [Parameter Value] [Parameter Unit]\"\n for each parameter in the interval combination",
"properties": {
"interval": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Interval"
},
"intervalParams": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalparams"
},
"intervalString": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalstring"
}
},
"title": "IntervalCombination",
"type": "object"
},
"InventoryCategory": {
"enum": [
"RawMaterials",
"Consumables",
"Equipment",
"Formulas"
],
"title": "InventoryCategory",
"type": "string"
},
"InventoryItem": {
"description": "An InventoryItem is a Pydantic model representing an item in the inventory. Can be a raw material, consumable, equipment, or formula.\nNote: Formulas should be registered via the Worksheet collection / Sheet resource.\n\nReturns\n-------\nInventoryItem\n An InventoryItem that can be used to represent an item in the inventory. Can be a raw material, consumable, equipment, or formula.\n\nAttributes\n------\n\nname : str\n The name of the InventoryItem.\nid : str | None\n The Albert ID of the InventoryItem. Set when the InventoryItem is retrieved from Albert.\ndescription : str | None\n The description of the InventoryItem.\ncategory : InventoryCategory\n The category of the InventoryItem. Allowed values are `RawMaterials`, `Consumables`, `Equipment`, and `Formulas`.\nunit_category : InventoryUnitCategory\n The unit category of the InventoryItem. Can be mass, volume, length, pressure, or units. By default, mass is used for RawMaterials and Formulas, and units is used for Equipment and Consumables.\nsecurity_class : SecurityClass | None\n The security class of the InventoryItem. Optional. Can be confidential, shared, or restricted.\ncompany : Company | str | None\n The company associated with the InventoryItem. Can be a Company object or a string. If a String is provided, a Company object with the name of the provided string will be first-or-created.\nminimum : list[InventoryMinimum] | None\n The minimum amount of the InventoryItem that must be kept in stock at a given Location. Optional.\nalias : str | None\n An alias for the InventoryItem. Optional.\ncas : list[CasAmount] | None\n The CAS numbers associated with the InventoryItem. This is how a compositional breakdown can be provided. Optional.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n Metadata associated with the InventoryItem. Optional. Allowed metadata fields can be found in the CustomFields documentation.\nproject_id : str | None\n The project ID associated with the InventoryItem. Read Only. Required for Formulas.\nformula_id : str | None\n The formula ID associated with the InventoryItem. Read Only.\ntags : list[str|Tag] | None\n The tags associated with the InventoryItem. Optional. If a string is provided, a Tag object with the name of the provided string will be first-or-created.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"category": {
"$ref": "#/$defs/InventoryCategory"
},
"unitCategory": {
"anyOf": [
{
"$ref": "#/$defs/InventoryUnitCategory"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"Company": {
"anyOf": [
{
"$ref": "#/$defs/Company"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Company"
},
"minimum": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/InventoryMinimum"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias"
},
"Cas": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CasAmount"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Cas"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"ACL": {
"items": {
"$ref": "#/$defs/ACL"
},
"title": "Acl",
"type": "array"
},
"TaskConfig": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskconfig"
},
"formulaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Formulaid"
},
"Symbols": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Symbols"
},
"unNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unnumber"
},
"recentAttachmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Recentattachmentid"
}
},
"required": [
"category"
],
"title": "InventoryItem",
"type": "object"
},
"InventoryMinimum": {
"description": "Defined the minimum amount of an InventoryItem that must be kept in stock at a given Location.\n\nAttributes\n----------\nid : str\n The unique identifier of the Location object associated with this InventoryMinimum.\n Provide either a Location or a location id.\nlocation : Location\n The Location object associated with this InventoryMinimum. Provide either a Location or a location id.\nminimum : float\n The minimum amount of the InventoryItem that must be kept in stock at the given Location.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"type": "null"
}
],
"default": null
},
"minimum": {
"maximum": 1000000000000000,
"minimum": 0,
"title": "Minimum",
"type": "number"
}
},
"required": [
"minimum"
],
"title": "InventoryMinimum",
"type": "object"
},
"InventoryUnitCategory": {
"enum": [
"mass",
"volume",
"length",
"pressure",
"units"
],
"title": "InventoryUnitCategory",
"type": "string"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"Operator": {
"enum": [
"between",
"lt",
"lte",
"gte",
"gt",
"eq"
],
"title": "Operator",
"type": "string"
},
"PGType": {
"description": "The type of a parameter group",
"enum": [
"general",
"batch",
"property"
],
"title": "PGType",
"type": "string"
},
"Parameter": {
"description": "A parameter in Albert.\n\nAttributes\n----------\nname : str\n The name of the parameter. Names must be unique.\nid : str | None\n The Albert ID of the parameter. Set when the parameter is retrieved from Albert.\ncategory : ParameterCategory\n The category of the parameter. Allowed values are `Normal` and `Special`. Read-only.\nrank : int\n The rank of the returned parameter. Read-only.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"rank": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Rank"
}
},
"required": [
"name"
],
"title": "Parameter",
"type": "object"
},
"ParameterCategory": {
"description": "The category of a parameter",
"enum": [
"Normal",
"Special"
],
"title": "ParameterCategory",
"type": "string"
},
"ParameterGroup": {
"description": "Use 'Standards' key in metadata to store standards",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PGType"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"class": {
"$ref": "#/$defs/SecurityClass",
"default": "restricted"
},
"ACL": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Acl"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Parameters": {
"items": {
"$ref": "#/$defs/ParameterValue"
},
"title": "Parameters",
"type": "array"
},
"verified": {
"default": false,
"title": "Verified",
"type": "boolean"
},
"documents": {
"items": {
"$ref": "#/$defs/EntityLink"
},
"title": "Documents",
"type": "array"
}
},
"required": [
"name"
],
"title": "ParameterGroup",
"type": "object"
},
"ParameterGroupSetpoints": {
"description": "A class that represents the setpoints on a parameter group.\n\n\nAttributes\n----------\nparameter_group : ParameterGroup\n The parameter group to set the setpoints on. Provide either a parameter_group or a paramerter_group_id\nparameter_group_id : ParameterGroupId\n The id of the parameter group. Provide either a parameter_group or a paramerter_group_id\nparameter_group_name : str\n The name of the parameter group. This is a read-only field.\nparameter_setpoints : list[ParameterSetpoint]\n The setpoints to apply to the parameter group.",
"properties": {
"parameter_group": {
"anyOf": [
{
"$ref": "#/$defs/ParameterGroup"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"Parameters": {
"items": {
"$ref": "#/$defs/ParameterSetpoint"
},
"title": "Parameters",
"type": "array"
}
},
"title": "ParameterGroupSetpoints",
"type": "object"
},
"ParameterSetpoint": {
"description": "A Pydantic class representing the setpoint or intervals of a parameter to use.\nFor a single value, provide the value and unit. For multiple values, provide intervals.\na parameter or parameter_id must be provided.\n\nAttributes\n----------\nparameter : Parameter\n The parameter to set the setpoint on. Provide either a parameter or a parameter_id.\nparameter_id : ParameterId\n The id of the parameter. Provide either a parameter or a parameter_id.\nvalue : str | EntityLink\n The value of the setpoint. If the parameter is a InventoryItem, provide the EntityLink of the InventoryItem.\nunit : Unit\n The unit of the setpoint.\nintervals : list[Interval]\n The intervals of the setpoint. Either ether intervals or value + unit\ncategory : ParameterCategory\n The category of the parameter. Special for InventoryItem (then use name to specify \"Equipment\", \"Consumeable\", etc), normal for all others\nshort_name : str\n The short / display name of the parameter. Required if value is a dictionary.\nrow_id : RowId\n The id of the parameter with respect to the interval row id.",
"properties": {
"parameter": {
"anyOf": [
{
"$ref": "#/$defs/Parameter"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"Intervals": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Interval"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervals"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shortname"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rowid"
}
},
"title": "ParameterSetpoint",
"type": "object"
},
"ParameterValue": {
"description": "The value of a parameter in a parameter group.\n\nAttributes\n----------\nparameter : Parameter\n The Parameter resource this value is associated with. Provide either an id or a parameter keyword argument.\nid : str | None\n The Albert ID of the Parameter resource this value is associated with. Provide either an id or a parameter keyword argument.\ncategory: ParameterCategory\n The category of the parameter.\nshort_name : str | None\n The short name of the parameter value.\nvalue : str | None\n The default value of the parameter. Can be a string or an InventoryItem (if, for example, the parameter is an instrumnt choice).\nunit : Unit | None\n The unit of measure for the provided parameter value.\nname : str\n The name of the parameter. Read-only.\nsequence : int\n The sequence of the parameter. Read-only.",
"properties": {
"parameter": {
"$ref": "#/$defs/Parameter",
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shortname"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/InventoryItem"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"Added": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"validation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ValueValidation"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Validation"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"sequence": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence"
},
"originalShortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originalshortname"
},
"originalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originalname"
}
},
"title": "ParameterValue",
"type": "object"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"SecurityClass": {
"description": "The security class of a resource",
"enum": [
"shared",
"restricted",
"confidential",
"private",
"public"
],
"title": "SecurityClass",
"type": "string"
},
"Standard": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"standardId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"standardOrganization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardorganization"
}
},
"required": [
"id"
],
"title": "Standard",
"type": "object"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"Tag": {
"description": "Tag is a Pydantic model representing a tag entity.\n\nAttributes\n----------\ntag : str\n The name of the tag.\nid : str | None\n The Albert ID of the tag. Set when the tag is retrieved from Albert.\n\nMethods\n-------\nfrom_string(tag: str) -> \"Tag\"\n Creates a Tag object from a string.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name"
],
"title": "Tag",
"type": "object"
},
"Target": {
"properties": {
"dataColumnUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datacolumnuniqueid"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "Target",
"type": "object"
},
"Unit": {
"description": "Unit is a Pydantic model representing a unit entity.\n\nAttributes\n----------\nid : str | None\n The Albert ID of the unit. Set when the unit is retrieved from Albert.\nname : str\n The name of the unit.\nsymbol : str | None\n The symbol of the unit.\nsynonyms : List[str] | None\n The list of synonyms for the unit.\ncategory : UnitCategory\n The category of the unit.\nverified : bool | None\n Whether the unit is verified.\nstatus : Status | None\n The status of the unit. Allowed values are `active`, and `inactive`",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Symbol"
},
"Synonyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Synonyms"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/UnitCategory"
},
{
"type": "null"
}
],
"default": null
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Verified"
}
},
"required": [
"name"
],
"title": "Unit",
"type": "object"
},
"UnitCategory": {
"description": "UnitCategory is an enumeration of possible unit categories.\n\nAttributes\n----------\nLENGTH : str\n Represents length units.\nVOLUME : str\n Represents volume units.\nLIQUID_VOLUME : str\n Represents liquid volume units.\nANGLES : str\n Represents angle units.\nTIME : str\n Represents time units.\nFREQUENCY : str\n Represents frequency units.\nMASS : str\n Represents mass units.\nCURRENT : str\n Represents electric current units.\nTEMPERATURE : str\n Represents temperature units.\nAMOUNT : str\n Represents amount of substance units.\nLUMINOSITY : str\n Represents luminous intensity units.\nFORCE : str\n Represents force units.\nENERGY : str\n Represents energy units.\nPOWER : str\n Represents power units.\nPRESSURE : str\n Represents pressure units.\nELECTRICITY_AND_MAGNETISM : str\n Represents electricity and magnetism units.\nOTHER : str\n Represents other units.\nWEIGHT : str\n Represents weight units.",
"enum": [
"Length",
"Volume",
"Liquid volume",
"Angles",
"Time",
"Frequency",
"Mass",
"Electric current",
"Temperature",
"Amount of substance",
"Luminous intensity",
"Force",
"Energy",
"Power",
"Pressure",
"Electricity and magnetism",
"Other",
"Weight",
"Area",
"Surface Area",
"Binary",
"Capacitance",
"Speed",
"Electrical conductivity",
"Electrical permitivitty",
"Density",
"Resistance"
],
"title": "UnitCategory",
"type": "string"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
},
"ValueValidation": {
"properties": {
"datatype": {
"$ref": "#/$defs/DataType"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/$defs/EnumValidationValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"min": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Max"
},
"operator": {
"anyOf": [
{
"$ref": "#/$defs/Operator"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"datatype"
],
"title": "ValueValidation",
"type": "object"
},
"Workflow": {
"description": "A Pydantic Class representing a workflow in Albert.\n\nWorkflows are combinations of Data Templates and Parameter groups and their associated setpoints.\n\nAttributes\n----------\nname : str\n The name of the workflow.\nparameter_group_setpoints : list[ParameterGroupSetpoints]\n The setpoints to apply to the parameter groups in the workflow.\nid : str | None\n The AlbertID of the workflow. This is set when a workflow is retrived from the platform.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"ParameterGroups": {
"items": {
"$ref": "#/$defs/ParameterGroupSetpoints"
},
"title": "Parametergroups",
"type": "array"
},
"IntervalCombinations": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalCombination"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalcombinations"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name",
"ParameterGroups"
],
"title": "Workflow",
"type": "object"
}
},
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"Workflow": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Workflow"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"minItems": 1,
"title": "Workflow",
"type": "array"
},
"Datatemplate": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockDataTemplateInfo"
},
"type": "array"
},
{
"$ref": "#/$defs/DataTemplateAndTargets"
},
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/DataTemplate"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
}
],
"maxLength": 1,
"minLength": 1,
"title": "Datatemplate"
},
"parameterQuantityUsed": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Parameterquantityused"
}
},
"required": [
"Workflow",
"Datatemplate"
],
"title": "Block",
"type": "object"
}
Fields:
-
id(str | None) -
workflow(list[SerializeAsEntityLink[Workflow]]) -
data_template(list[BlockDataTemplateInfo] | DataTemplateAndTargets | list[SerializeAsEntityLink[DataTemplate]]) -
parameter_quantity_used(dict | None)
data_template: (
list[BlockDataTemplateInfo]
| DataTemplateAndTargets
| list[SerializeAsEntityLink[DataTemplate]]
)
Source code in src/albert/resources/tasks.py
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"QCTarget": {
"properties": {
"formulaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Formulaid"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
}
},
"title": "QCTarget",
"type": "object"
}
},
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"taskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskname"
},
"Targets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/QCTarget"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Targets"
}
},
"title": "QCWorkflowTargets",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
Show JSON schema:
{
"$defs": {
"QCTarget": {
"properties": {
"formulaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Formulaid"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
}
},
"title": "QCTarget",
"type": "object"
},
"QCWorkflowTargets": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"taskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskname"
},
"Targets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/QCTarget"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Targets"
}
},
"title": "QCWorkflowTargets",
"type": "object"
}
},
"properties": {
"datatemplateId": {
"title": "Datatemplateid",
"type": "string"
},
"Workflows": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/QCWorkflowTargets"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflows"
}
},
"required": [
"datatemplateId"
],
"title": "QCTaskData",
"type": "object"
}
Fields:
-
data_template_id(str) -
workflows(list[QCWorkflowTargets] | None)
Bases: BaseTaggedResource
Base class for all task types. Use PropertyTask, BatchTask, or GeneralTask for specific task types.
Show JSON schema:
{
"$defs": {
"ACL": {
"description": "The Access Control List (ACL) for a user",
"properties": {
"id": {
"description": "The id of the user for which this ACL applies",
"title": "Id",
"type": "string"
},
"fgc": {
"anyOf": [
{
"$ref": "#/$defs/AccessControlLevel"
},
{
"type": "null"
}
],
"default": null,
"description": "The Fine-Grain Control Level"
}
},
"required": [
"id"
],
"title": "ACL",
"type": "object"
},
"AccessControlLevel": {
"description": "The fine grain control",
"enum": [
"ProjectOwner",
"ProjectEditor",
"ProjectViewer",
"ProjectAllTask",
"ProjectPropertyTask",
"InventoryOwner",
"InventoryViewer",
"CustomTemplateOwner"
],
"title": "AccessControlLevel",
"type": "string"
},
"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"
},
"BlockLevelInventoryInformation": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
},
"BlockState": {
"properties": {
"id": {
"description": "The ID of the block.",
"title": "Id",
"type": "string"
},
"expand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Expand"
},
"Interval": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalId"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The IDs of the interval (e.g., id: ROW2XROW4)",
"title": "Interval"
},
"Inventory": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockLevelInventoryInformation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventory"
}
},
"required": [
"id"
],
"title": "BlockState",
"type": "object"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"GridDefault": {
"description": "The default grid for a project",
"enum": [
"PD",
"WKS"
],
"title": "GridDefault",
"type": "string"
},
"IntervalId": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "IntervalId",
"type": "object"
},
"InventoryInformation": {
"description": "Represents the Inventory information needed for a task. For a Batch task, inventory_id and batch_size are required.\nFor Property and general tasks, inventory_id and lot_id is recomended is required.\n\nAttributes\n----------\ninventory_id : str\n The inventory id of the item to be used in the task.\nlot_id : str, optional\n The lot id of the item to be used in the task. Reccomended for Property and General tasks.\nbatch_size : float, Required for Batch tasks, otherwise optional.\n The batch size to make of the related InventoryItem. Required for Batch tasks.\nselected_lot : bool, read only\n Whether the lot is selected for the task. Default is None.",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
},
"batchSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchsize"
},
"selectedLot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Selectedlot"
},
"barcodeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Barcodeid"
},
"quantityUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Quantityused"
}
},
"required": [
"id"
],
"title": "InventoryInformation",
"type": "object"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"PageState": {
"properties": {
"leftPanelExpand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Leftpanelexpand"
},
"Block": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockState"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Block"
}
},
"title": "PageState",
"type": "object"
},
"Project": {
"description": "A project in Albert.\n\nAttributes\n----------\ndescription : str\n The description of the project. Used as the name of the project as well.\nid : str | None\n The Albert ID of the project. Set when the project is retrieved from Albert.\nlocations : list[Location] | None\n The locations associated with the project. Optional.\nproject_class : ProjectClass\n The class of the project. Defaults to PRIVATE.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n The metadata of the project. Optional. Metadata allowed values can be found using the Custom Fields API.\nprefix : str | None\n The prefix of the project. Optional.\n\nacl : list[ACL] | None\n The ACL of the project. Optional.\ntask_config : list[TaskConfig] | None\n The task configuration of the project. Optional.\ngrid : GridDefault | None\n The default grid of the project. Optional.\nstate : State | None\n The state/status of the project. Allowed states are customizeable using the entitystatus API. Optional.\napplication_engineering_inventory_ids : list[str] | None\n Inventory Ids to be added as application engineering. Optional.",
"properties": {
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"maxLength": 2000,
"minLength": 1,
"title": "Description",
"type": "string"
},
"Locations": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Locations"
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/ProjectClass"
},
{
"type": "null"
}
],
"default": "private"
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prefix"
},
"appEngg": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Inventory Ids to be added as application engineering",
"title": "Appengg"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"ACL": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ACL"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acl"
},
"old_api_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Old Api Params"
},
"task_config": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskConfig"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Task Config"
},
"grid": {
"anyOf": [
{
"$ref": "#/$defs/GridDefault"
},
{
"type": "null"
}
],
"default": null
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/State"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"description"
],
"title": "Project",
"type": "object"
},
"ProjectClass": {
"description": "The ACL Class of a project",
"enum": [
"shared",
"public",
"confidential",
"private"
],
"title": "ProjectClass",
"type": "string"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"SecurityClass": {
"description": "The security class of a resource",
"enum": [
"shared",
"restricted",
"confidential",
"private",
"public"
],
"title": "SecurityClass",
"type": "string"
},
"State": {
"description": "The current state of a project",
"enum": [
"Not Started",
"Active",
"Closed - Success",
"Closed - Archived"
],
"title": "State",
"type": "string"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"Tag": {
"description": "Tag is a Pydantic model representing a tag entity.\n\nAttributes\n----------\ntag : str\n The name of the tag.\nid : str | None\n The Albert ID of the tag. Set when the tag is retrieved from Albert.\n\nMethods\n-------\nfrom_string(tag: str) -> \"Tag\"\n Creates a Tag object from a string.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name"
],
"title": "Tag",
"type": "object"
},
"TaskCategory": {
"enum": [
"Property",
"Batch",
"General",
"BatchWithQC"
],
"title": "TaskCategory",
"type": "string"
},
"TaskConfig": {
"description": "The task configuration for a project",
"properties": {
"datatemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datatemplateid"
},
"workflowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflowid"
},
"defaultTaskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Defaulttaskname"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"hidden": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Hidden"
}
},
"title": "TaskConfig",
"type": "object"
},
"TaskPriority": {
"enum": [
"High",
"Medium",
"Low"
],
"title": "TaskPriority",
"type": "string"
},
"TaskSource": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"type": {
"$ref": "#/$defs/TaskSourceType"
}
},
"required": [
"id",
"type"
],
"title": "TaskSource",
"type": "object"
},
"TaskSourceType": {
"enum": [
"task",
"template"
],
"title": "TaskSourceType",
"type": "string"
},
"TaskState": {
"enum": [
"Unclaimed",
"Not Started",
"In Progress",
"Completed",
"Closed"
],
"title": "TaskState",
"type": "string"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
}
},
"description": "Base class for all task types. Use PropertyTask, BatchTask, or GeneralTask for specific task types.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"category": {
"$ref": "#/$defs/TaskCategory"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Sources": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskSource"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sources"
},
"Inventories": {
"default": null,
"items": {
"$ref": "#/$defs/InventoryInformation"
},
"title": "Inventories",
"type": "array"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"priority": {
"anyOf": [
{
"$ref": "#/$defs/TaskPriority"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"passOrFail": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Passorfail"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"startDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Startdate"
},
"dueDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duedate"
},
"claimedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Claimeddate"
},
"completedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Completeddate"
},
"closedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closeddate"
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Result"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/TaskState"
},
{
"type": "null"
}
],
"default": null
},
"Project": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Project"
},
"AssignedTo": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignedto"
},
"PageState": {
"anyOf": [
{
"$ref": "#/$defs/PageState"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"category"
],
"title": "BaseTask",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
tags(list[SerializeAsEntityLink[Tag]] | None) -
id(str | None) -
name(str) -
category(TaskCategory) -
parent_id(str | None) -
metadata(dict[str, MetadataItem]) -
sources(list[TaskSource] | None) -
inventory_information(list[InventoryInformation]) -
location(SerializeAsEntityLink[Location] | None) -
priority(TaskPriority | None) -
security_class(SecurityClass | None) -
pass_fail(bool | None) -
notes(str | None) -
start_date(str | None) -
due_date(str | None) -
claimed_date(str | None) -
completed_date(str | None) -
closed_date(str | None) -
result(str | None) -
state(TaskState | None) -
project(SerializeAsEntityLink[Project] | list[SerializeAsEntityLink[Project]] | None) -
assigned_to(SerializeAsEntityLink[User] | None) -
page_state(PageState | None)
Bases: BaseTask
Represents a batch task.
This class is used to create and manage batch tasks. It includes the base task attributes and additional attributes specific to batch tasks.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the batch task. |
inventory_information |
list[InventoryInformation]
|
Information about the inventory associated with the batch task. |
location |
SerializeAsEntityLink[Location]
|
The location where the batch task is performed. |
parent_id |
str
|
The ID of the parent project. |
blocks |
list[Block]
|
A list of blocks associated with the batch task. |
id |
(str, optional)
|
The ID of the batch task, by default None. |
metadata |
(dict[str, MetadataItem], optional)
|
Metadata associated with the batch task, by default an empty dictionary. |
due_date |
(str, optional)
|
The due date of the batch task. YYY-MM-DD format, by default None. |
notes |
(str, optional)
|
Notes associated with the batch task, by default None. |
priority |
(TaskPriority, optional)
|
The priority of the batch task, by default None. |
assigned_to |
(SerializeAsEntityLink[User], optional)
|
The user assigned to the batch task, by default None. |
state |
(TaskState, optional)
|
The state of the batch task, by default None. |
sources |
(list[TaskSource], optional)
|
A list of sources associated with the batch task, by default an empty list. |
security_class |
(SecurityClass, optional)
|
The security class of the batch task, by default None. |
start_date |
str, read only
|
The start date of the batch task, by default None. |
claimed_date |
str, read only
|
The claimed date of the batch task, by default None. |
completed_date |
str, read only
|
The completed date of the batch task, by default None. |
closed_date |
str, read only
|
The closed date of the batch task, by default None. |
Show JSON schema:
{
"$defs": {
"ACL": {
"description": "The Access Control List (ACL) for a user",
"properties": {
"id": {
"description": "The id of the user for which this ACL applies",
"title": "Id",
"type": "string"
},
"fgc": {
"anyOf": [
{
"$ref": "#/$defs/AccessControlLevel"
},
{
"type": "null"
}
],
"default": null,
"description": "The Fine-Grain Control Level"
}
},
"required": [
"id"
],
"title": "ACL",
"type": "object"
},
"AccessControlLevel": {
"description": "The fine grain control",
"enum": [
"ProjectOwner",
"ProjectEditor",
"ProjectViewer",
"ProjectAllTask",
"ProjectPropertyTask",
"InventoryOwner",
"InventoryViewer",
"CustomTemplateOwner"
],
"title": "AccessControlLevel",
"type": "string"
},
"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"
},
"Block": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"Workflow": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Workflow"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"minItems": 1,
"title": "Workflow",
"type": "array"
},
"Datatemplate": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockDataTemplateInfo"
},
"type": "array"
},
{
"$ref": "#/$defs/DataTemplateAndTargets"
},
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/DataTemplate"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
}
],
"maxLength": 1,
"minLength": 1,
"title": "Datatemplate"
},
"parameterQuantityUsed": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Parameterquantityused"
}
},
"required": [
"Workflow",
"Datatemplate"
],
"title": "Block",
"type": "object"
},
"BlockDataTemplateInfo": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"fullName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Fullname"
},
"Standards": {
"anyOf": [
{
"$ref": "#/$defs/Standard"
},
{
"type": "null"
}
],
"default": null
},
"Targets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Target"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Targets"
}
},
"required": [
"id",
"name"
],
"title": "BlockDataTemplateInfo",
"type": "object"
},
"BlockLevelInventoryInformation": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
},
"BlockState": {
"properties": {
"id": {
"description": "The ID of the block.",
"title": "Id",
"type": "string"
},
"expand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Expand"
},
"Interval": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalId"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The IDs of the interval (e.g., id: ROW2XROW4)",
"title": "Interval"
},
"Inventory": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockLevelInventoryInformation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventory"
}
},
"required": [
"id"
],
"title": "BlockState",
"type": "object"
},
"Cas": {
"description": "Represents a CAS entity.",
"properties": {
"number": {
"description": "The CAS number.",
"title": "Number",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the CAS.",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description or name of the CAS.",
"title": "Description"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Notes related to the CAS.",
"title": "Notes"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/CasCategory"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of the CAS."
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "CAS SMILES notation.",
"title": "Cassmiles"
},
"inchiKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "InChIKey of the CAS.",
"title": "Inchikey"
},
"iUpacName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "IUPAC name of the CAS.",
"title": "Iupacname"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The AlbertID of the CAS.",
"title": "Albertid"
},
"hazards": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Hazard"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazards associated with the CAS.",
"title": "Hazards"
},
"wgk": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "German Water Hazard Class (WGK) number.",
"title": "Wgk"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "European Community (EC) number.",
"title": "Eclistno"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of the CAS.",
"title": "Type"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Classification type of the CAS.",
"title": "Classificationtype"
},
"order": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "CAS order.",
"title": "Order"
}
},
"required": [
"number"
],
"title": "Cas",
"type": "object"
},
"CasAmount": {
"description": "CasAmount is a Pydantic model representing an amount of a given CAS.\n\nAttributes\n----------\nmin : float\n The minimum amount of the CAS in the formulation.\nmax : float\n The maximum amount of the CAS in the formulation.\nid : str | None\n The Albert ID of the CAS Number Resource this amount represents. Provide either a Cas or an ID.\ncas : Cas | None\n The CAS object associated with this amount. Provide either a Cas or an id.\ncas_smiles: str | None\n The SMILES string of the CAS Number resource. Obtained from the Cas object when provided.\nnumber: str | None\n The CAS number. Obtained from the Cas object when provided.",
"properties": {
"min": {
"title": "Min",
"type": "number"
},
"max": {
"title": "Max",
"type": "number"
},
"inventoryValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventoryvalue"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"casCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cascategory"
},
"cas": {
"anyOf": [
{
"$ref": "#/$defs/Cas"
},
{
"type": "null"
}
],
"default": null
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cassmiles"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
}
},
"required": [
"min",
"max"
],
"title": "CasAmount",
"type": "object"
},
"CasCategory": {
"enum": [
"User",
"Verisk",
"TSCA - Public",
"TSCA - Private",
"not TSCA",
"CAS linked to External Database",
"Unknown (Trade Secret)",
"CL_Inventory Upload"
],
"title": "CasCategory",
"type": "string"
},
"Company": {
"description": "Company is a Pydantic model representing a company entity.\n\nAttributes\n----------\nname : str\n The name of the company.\nid : str | None\n The Albert ID of the company. Set when the company is retrieved from Albert.\ndistance : float | None\n The scores of a company in a search result, optional. Read-only.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"distance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Distance"
}
},
"required": [
"name"
],
"title": "Company",
"type": "object"
},
"DataColumn": {
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"defalt": {
"default": false,
"title": "Defalt",
"type": "boolean"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"albertId": {
"default": null,
"title": "Albertid",
"type": "string"
}
},
"required": [
"name"
],
"title": "DataColumn",
"type": "object"
},
"DataColumnValue": {
"properties": {
"data_column": {
"$ref": "#/$defs/DataColumn",
"default": null
},
"id": {
"default": null,
"title": "Id",
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"hidden": {
"default": false,
"title": "Hidden",
"type": "boolean"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"calculation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Calculation"
},
"sequence": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence"
},
"validation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ValueValidation"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Validation"
}
},
"title": "DataColumnValue",
"type": "object"
},
"DataTemplate": {
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"security_class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"verified": {
"default": false,
"title": "Verified",
"type": "boolean"
},
"ACL": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Acl"
},
"DataColumns": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataColumnValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Datacolumns"
},
"Parameters": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ParameterValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Parameters"
},
"DeletedParameters": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ParameterValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Deletedparameters"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "DataTemplate",
"type": "object"
},
"DataTemplateAndTargets": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"targets": {
"items": {
"$ref": "#/$defs/Target"
},
"title": "Targets",
"type": "array"
}
},
"required": [
"id",
"targets"
],
"title": "DataTemplateAndTargets",
"type": "object"
},
"DataType": {
"enum": [
"number",
"string",
"enum"
],
"title": "DataType",
"type": "string"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"EnumValidationValue": {
"description": "Represents a value for an enum type validation.\n\nAttributes\n----------\ntext : str\n The text of the enum value.\nid : str | None\n The ID of the enum value. If not provided, the ID will be generated upon creation.",
"properties": {
"text": {
"title": "Text",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"originalText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originaltext"
}
},
"required": [
"text"
],
"title": "EnumValidationValue",
"type": "object"
},
"GridDefault": {
"description": "The default grid for a project",
"enum": [
"PD",
"WKS"
],
"title": "GridDefault",
"type": "string"
},
"Hazard": {
"description": "Represents a chemical hazard.",
"properties": {
"subCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard subcategory",
"title": "Subcategory"
},
"hCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard code",
"title": "Hcode"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard category",
"title": "Category"
},
"class": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard classification",
"title": "Class"
},
"hCodeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard code text",
"title": "Hcodetext"
}
},
"title": "Hazard",
"type": "object"
},
"Interval": {
"description": "A Pydantic class representing an interval.\n\nAttrubutes\n----------\nvalue : str\n The value of the interval setpoint.\nunit : Unit\n The unit of the related value.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rowid"
}
},
"title": "Interval",
"type": "object"
},
"IntervalCombination": {
"description": "A class representing the interval combinations of on a workflow.\nThis is returned by the workflow endpoint when at least one parameter\nin the workflow has been intervalized.\n\nInterval Combinations can be single intervalized parameters or cartesian prodcuts of\ntwo intervalized parameters.\n\nAttributes\n----------\ninterval_id: IntervalId | None\n forign key reference to the interval id\n this combination is associated with\n It will have the form ROW# or ROW#XROW# depending on\n if it is a single interval or a product of two intervals\ninterval_params: str | None\n The parameters participating in the interval.\ninterval_string: str | None\n The string representation of the interval combination\n This will have the form \"[Parameter Name]: [Parameter Value] [Parameter Unit]\"\n for each parameter in the interval combination",
"properties": {
"interval": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Interval"
},
"intervalParams": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalparams"
},
"intervalString": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalstring"
}
},
"title": "IntervalCombination",
"type": "object"
},
"IntervalId": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "IntervalId",
"type": "object"
},
"InventoryCategory": {
"enum": [
"RawMaterials",
"Consumables",
"Equipment",
"Formulas"
],
"title": "InventoryCategory",
"type": "string"
},
"InventoryInformation": {
"description": "Represents the Inventory information needed for a task. For a Batch task, inventory_id and batch_size are required.\nFor Property and general tasks, inventory_id and lot_id is recomended is required.\n\nAttributes\n----------\ninventory_id : str\n The inventory id of the item to be used in the task.\nlot_id : str, optional\n The lot id of the item to be used in the task. Reccomended for Property and General tasks.\nbatch_size : float, Required for Batch tasks, otherwise optional.\n The batch size to make of the related InventoryItem. Required for Batch tasks.\nselected_lot : bool, read only\n Whether the lot is selected for the task. Default is None.",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
},
"batchSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchsize"
},
"selectedLot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Selectedlot"
},
"barcodeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Barcodeid"
},
"quantityUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Quantityused"
}
},
"required": [
"id"
],
"title": "InventoryInformation",
"type": "object"
},
"InventoryItem": {
"description": "An InventoryItem is a Pydantic model representing an item in the inventory. Can be a raw material, consumable, equipment, or formula.\nNote: Formulas should be registered via the Worksheet collection / Sheet resource.\n\nReturns\n-------\nInventoryItem\n An InventoryItem that can be used to represent an item in the inventory. Can be a raw material, consumable, equipment, or formula.\n\nAttributes\n------\n\nname : str\n The name of the InventoryItem.\nid : str | None\n The Albert ID of the InventoryItem. Set when the InventoryItem is retrieved from Albert.\ndescription : str | None\n The description of the InventoryItem.\ncategory : InventoryCategory\n The category of the InventoryItem. Allowed values are `RawMaterials`, `Consumables`, `Equipment`, and `Formulas`.\nunit_category : InventoryUnitCategory\n The unit category of the InventoryItem. Can be mass, volume, length, pressure, or units. By default, mass is used for RawMaterials and Formulas, and units is used for Equipment and Consumables.\nsecurity_class : SecurityClass | None\n The security class of the InventoryItem. Optional. Can be confidential, shared, or restricted.\ncompany : Company | str | None\n The company associated with the InventoryItem. Can be a Company object or a string. If a String is provided, a Company object with the name of the provided string will be first-or-created.\nminimum : list[InventoryMinimum] | None\n The minimum amount of the InventoryItem that must be kept in stock at a given Location. Optional.\nalias : str | None\n An alias for the InventoryItem. Optional.\ncas : list[CasAmount] | None\n The CAS numbers associated with the InventoryItem. This is how a compositional breakdown can be provided. Optional.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n Metadata associated with the InventoryItem. Optional. Allowed metadata fields can be found in the CustomFields documentation.\nproject_id : str | None\n The project ID associated with the InventoryItem. Read Only. Required for Formulas.\nformula_id : str | None\n The formula ID associated with the InventoryItem. Read Only.\ntags : list[str|Tag] | None\n The tags associated with the InventoryItem. Optional. If a string is provided, a Tag object with the name of the provided string will be first-or-created.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"category": {
"$ref": "#/$defs/InventoryCategory"
},
"unitCategory": {
"anyOf": [
{
"$ref": "#/$defs/InventoryUnitCategory"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"Company": {
"anyOf": [
{
"$ref": "#/$defs/Company"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Company"
},
"minimum": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/InventoryMinimum"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias"
},
"Cas": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CasAmount"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Cas"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"ACL": {
"items": {
"$ref": "#/$defs/ACL"
},
"title": "Acl",
"type": "array"
},
"TaskConfig": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskconfig"
},
"formulaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Formulaid"
},
"Symbols": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Symbols"
},
"unNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unnumber"
},
"recentAttachmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Recentattachmentid"
}
},
"required": [
"category"
],
"title": "InventoryItem",
"type": "object"
},
"InventoryMinimum": {
"description": "Defined the minimum amount of an InventoryItem that must be kept in stock at a given Location.\n\nAttributes\n----------\nid : str\n The unique identifier of the Location object associated with this InventoryMinimum.\n Provide either a Location or a location id.\nlocation : Location\n The Location object associated with this InventoryMinimum. Provide either a Location or a location id.\nminimum : float\n The minimum amount of the InventoryItem that must be kept in stock at the given Location.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"type": "null"
}
],
"default": null
},
"minimum": {
"maximum": 1000000000000000,
"minimum": 0,
"title": "Minimum",
"type": "number"
}
},
"required": [
"minimum"
],
"title": "InventoryMinimum",
"type": "object"
},
"InventoryUnitCategory": {
"enum": [
"mass",
"volume",
"length",
"pressure",
"units"
],
"title": "InventoryUnitCategory",
"type": "string"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"Operator": {
"enum": [
"between",
"lt",
"lte",
"gte",
"gt",
"eq"
],
"title": "Operator",
"type": "string"
},
"PGType": {
"description": "The type of a parameter group",
"enum": [
"general",
"batch",
"property"
],
"title": "PGType",
"type": "string"
},
"PageState": {
"properties": {
"leftPanelExpand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Leftpanelexpand"
},
"Block": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockState"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Block"
}
},
"title": "PageState",
"type": "object"
},
"Parameter": {
"description": "A parameter in Albert.\n\nAttributes\n----------\nname : str\n The name of the parameter. Names must be unique.\nid : str | None\n The Albert ID of the parameter. Set when the parameter is retrieved from Albert.\ncategory : ParameterCategory\n The category of the parameter. Allowed values are `Normal` and `Special`. Read-only.\nrank : int\n The rank of the returned parameter. Read-only.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"rank": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Rank"
}
},
"required": [
"name"
],
"title": "Parameter",
"type": "object"
},
"ParameterCategory": {
"description": "The category of a parameter",
"enum": [
"Normal",
"Special"
],
"title": "ParameterCategory",
"type": "string"
},
"ParameterGroup": {
"description": "Use 'Standards' key in metadata to store standards",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PGType"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"class": {
"$ref": "#/$defs/SecurityClass",
"default": "restricted"
},
"ACL": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Acl"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Parameters": {
"items": {
"$ref": "#/$defs/ParameterValue"
},
"title": "Parameters",
"type": "array"
},
"verified": {
"default": false,
"title": "Verified",
"type": "boolean"
},
"documents": {
"items": {
"$ref": "#/$defs/EntityLink"
},
"title": "Documents",
"type": "array"
}
},
"required": [
"name"
],
"title": "ParameterGroup",
"type": "object"
},
"ParameterGroupSetpoints": {
"description": "A class that represents the setpoints on a parameter group.\n\n\nAttributes\n----------\nparameter_group : ParameterGroup\n The parameter group to set the setpoints on. Provide either a parameter_group or a paramerter_group_id\nparameter_group_id : ParameterGroupId\n The id of the parameter group. Provide either a parameter_group or a paramerter_group_id\nparameter_group_name : str\n The name of the parameter group. This is a read-only field.\nparameter_setpoints : list[ParameterSetpoint]\n The setpoints to apply to the parameter group.",
"properties": {
"parameter_group": {
"anyOf": [
{
"$ref": "#/$defs/ParameterGroup"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"Parameters": {
"items": {
"$ref": "#/$defs/ParameterSetpoint"
},
"title": "Parameters",
"type": "array"
}
},
"title": "ParameterGroupSetpoints",
"type": "object"
},
"ParameterSetpoint": {
"description": "A Pydantic class representing the setpoint or intervals of a parameter to use.\nFor a single value, provide the value and unit. For multiple values, provide intervals.\na parameter or parameter_id must be provided.\n\nAttributes\n----------\nparameter : Parameter\n The parameter to set the setpoint on. Provide either a parameter or a parameter_id.\nparameter_id : ParameterId\n The id of the parameter. Provide either a parameter or a parameter_id.\nvalue : str | EntityLink\n The value of the setpoint. If the parameter is a InventoryItem, provide the EntityLink of the InventoryItem.\nunit : Unit\n The unit of the setpoint.\nintervals : list[Interval]\n The intervals of the setpoint. Either ether intervals or value + unit\ncategory : ParameterCategory\n The category of the parameter. Special for InventoryItem (then use name to specify \"Equipment\", \"Consumeable\", etc), normal for all others\nshort_name : str\n The short / display name of the parameter. Required if value is a dictionary.\nrow_id : RowId\n The id of the parameter with respect to the interval row id.",
"properties": {
"parameter": {
"anyOf": [
{
"$ref": "#/$defs/Parameter"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"Intervals": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Interval"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervals"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shortname"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rowid"
}
},
"title": "ParameterSetpoint",
"type": "object"
},
"ParameterValue": {
"description": "The value of a parameter in a parameter group.\n\nAttributes\n----------\nparameter : Parameter\n The Parameter resource this value is associated with. Provide either an id or a parameter keyword argument.\nid : str | None\n The Albert ID of the Parameter resource this value is associated with. Provide either an id or a parameter keyword argument.\ncategory: ParameterCategory\n The category of the parameter.\nshort_name : str | None\n The short name of the parameter value.\nvalue : str | None\n The default value of the parameter. Can be a string or an InventoryItem (if, for example, the parameter is an instrumnt choice).\nunit : Unit | None\n The unit of measure for the provided parameter value.\nname : str\n The name of the parameter. Read-only.\nsequence : int\n The sequence of the parameter. Read-only.",
"properties": {
"parameter": {
"$ref": "#/$defs/Parameter",
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shortname"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/InventoryItem"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"Added": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"validation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ValueValidation"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Validation"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"sequence": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence"
},
"originalShortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originalshortname"
},
"originalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originalname"
}
},
"title": "ParameterValue",
"type": "object"
},
"Project": {
"description": "A project in Albert.\n\nAttributes\n----------\ndescription : str\n The description of the project. Used as the name of the project as well.\nid : str | None\n The Albert ID of the project. Set when the project is retrieved from Albert.\nlocations : list[Location] | None\n The locations associated with the project. Optional.\nproject_class : ProjectClass\n The class of the project. Defaults to PRIVATE.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n The metadata of the project. Optional. Metadata allowed values can be found using the Custom Fields API.\nprefix : str | None\n The prefix of the project. Optional.\n\nacl : list[ACL] | None\n The ACL of the project. Optional.\ntask_config : list[TaskConfig] | None\n The task configuration of the project. Optional.\ngrid : GridDefault | None\n The default grid of the project. Optional.\nstate : State | None\n The state/status of the project. Allowed states are customizeable using the entitystatus API. Optional.\napplication_engineering_inventory_ids : list[str] | None\n Inventory Ids to be added as application engineering. Optional.",
"properties": {
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"maxLength": 2000,
"minLength": 1,
"title": "Description",
"type": "string"
},
"Locations": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Locations"
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/ProjectClass"
},
{
"type": "null"
}
],
"default": "private"
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prefix"
},
"appEngg": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Inventory Ids to be added as application engineering",
"title": "Appengg"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"ACL": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ACL"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acl"
},
"old_api_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Old Api Params"
},
"task_config": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskConfig"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Task Config"
},
"grid": {
"anyOf": [
{
"$ref": "#/$defs/GridDefault"
},
{
"type": "null"
}
],
"default": null
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/State"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"description"
],
"title": "Project",
"type": "object"
},
"ProjectClass": {
"description": "The ACL Class of a project",
"enum": [
"shared",
"public",
"confidential",
"private"
],
"title": "ProjectClass",
"type": "string"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"SecurityClass": {
"description": "The security class of a resource",
"enum": [
"shared",
"restricted",
"confidential",
"private",
"public"
],
"title": "SecurityClass",
"type": "string"
},
"Standard": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"standardId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardid"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"standardOrganization": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Standardorganization"
}
},
"required": [
"id"
],
"title": "Standard",
"type": "object"
},
"State": {
"description": "The current state of a project",
"enum": [
"Not Started",
"Active",
"Closed - Success",
"Closed - Archived"
],
"title": "State",
"type": "string"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"Tag": {
"description": "Tag is a Pydantic model representing a tag entity.\n\nAttributes\n----------\ntag : str\n The name of the tag.\nid : str | None\n The Albert ID of the tag. Set when the tag is retrieved from Albert.\n\nMethods\n-------\nfrom_string(tag: str) -> \"Tag\"\n Creates a Tag object from a string.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name"
],
"title": "Tag",
"type": "object"
},
"Target": {
"properties": {
"dataColumnUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datacolumnuniqueid"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
}
},
"title": "Target",
"type": "object"
},
"TaskConfig": {
"description": "The task configuration for a project",
"properties": {
"datatemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datatemplateid"
},
"workflowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflowid"
},
"defaultTaskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Defaulttaskname"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"hidden": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Hidden"
}
},
"title": "TaskConfig",
"type": "object"
},
"TaskPriority": {
"enum": [
"High",
"Medium",
"Low"
],
"title": "TaskPriority",
"type": "string"
},
"TaskSource": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"type": {
"$ref": "#/$defs/TaskSourceType"
}
},
"required": [
"id",
"type"
],
"title": "TaskSource",
"type": "object"
},
"TaskSourceType": {
"enum": [
"task",
"template"
],
"title": "TaskSourceType",
"type": "string"
},
"TaskState": {
"enum": [
"Unclaimed",
"Not Started",
"In Progress",
"Completed",
"Closed"
],
"title": "TaskState",
"type": "string"
},
"Unit": {
"description": "Unit is a Pydantic model representing a unit entity.\n\nAttributes\n----------\nid : str | None\n The Albert ID of the unit. Set when the unit is retrieved from Albert.\nname : str\n The name of the unit.\nsymbol : str | None\n The symbol of the unit.\nsynonyms : List[str] | None\n The list of synonyms for the unit.\ncategory : UnitCategory\n The category of the unit.\nverified : bool | None\n Whether the unit is verified.\nstatus : Status | None\n The status of the unit. Allowed values are `active`, and `inactive`",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Symbol"
},
"Synonyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Synonyms"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/UnitCategory"
},
{
"type": "null"
}
],
"default": null
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Verified"
}
},
"required": [
"name"
],
"title": "Unit",
"type": "object"
},
"UnitCategory": {
"description": "UnitCategory is an enumeration of possible unit categories.\n\nAttributes\n----------\nLENGTH : str\n Represents length units.\nVOLUME : str\n Represents volume units.\nLIQUID_VOLUME : str\n Represents liquid volume units.\nANGLES : str\n Represents angle units.\nTIME : str\n Represents time units.\nFREQUENCY : str\n Represents frequency units.\nMASS : str\n Represents mass units.\nCURRENT : str\n Represents electric current units.\nTEMPERATURE : str\n Represents temperature units.\nAMOUNT : str\n Represents amount of substance units.\nLUMINOSITY : str\n Represents luminous intensity units.\nFORCE : str\n Represents force units.\nENERGY : str\n Represents energy units.\nPOWER : str\n Represents power units.\nPRESSURE : str\n Represents pressure units.\nELECTRICITY_AND_MAGNETISM : str\n Represents electricity and magnetism units.\nOTHER : str\n Represents other units.\nWEIGHT : str\n Represents weight units.",
"enum": [
"Length",
"Volume",
"Liquid volume",
"Angles",
"Time",
"Frequency",
"Mass",
"Electric current",
"Temperature",
"Amount of substance",
"Luminous intensity",
"Force",
"Energy",
"Power",
"Pressure",
"Electricity and magnetism",
"Other",
"Weight",
"Area",
"Surface Area",
"Binary",
"Capacitance",
"Speed",
"Electrical conductivity",
"Electrical permitivitty",
"Density",
"Resistance"
],
"title": "UnitCategory",
"type": "string"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
},
"ValueValidation": {
"properties": {
"datatype": {
"$ref": "#/$defs/DataType"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/$defs/EnumValidationValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"min": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Max"
},
"operator": {
"anyOf": [
{
"$ref": "#/$defs/Operator"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"datatype"
],
"title": "ValueValidation",
"type": "object"
},
"Workflow": {
"description": "A Pydantic Class representing a workflow in Albert.\n\nWorkflows are combinations of Data Templates and Parameter groups and their associated setpoints.\n\nAttributes\n----------\nname : str\n The name of the workflow.\nparameter_group_setpoints : list[ParameterGroupSetpoints]\n The setpoints to apply to the parameter groups in the workflow.\nid : str | None\n The AlbertID of the workflow. This is set when a workflow is retrived from the platform.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"ParameterGroups": {
"items": {
"$ref": "#/$defs/ParameterGroupSetpoints"
},
"title": "Parametergroups",
"type": "array"
},
"IntervalCombinations": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalCombination"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalcombinations"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name",
"ParameterGroups"
],
"title": "Workflow",
"type": "object"
}
},
"description": "Represents a batch task.\n\nThis class is used to create and manage batch tasks. It includes the base task attributes\nand additional attributes specific to batch tasks.\n\nAttributes\n----------\nname : str\n The name of the batch task.\ninventory_information : list[InventoryInformation]\n Information about the inventory associated with the batch task.\nlocation : SerializeAsEntityLink[Location]\n The location where the batch task is performed.\nparent_id : str\n The ID of the parent project.\nblocks : list[Block]\n A list of blocks associated with the batch task.\nid : str, optional\n The ID of the batch task, by default None.\n\nmetadata : dict[str, MetadataItem], optional\n Metadata associated with the batch task, by default an empty dictionary.\ndue_date : str, optional\n The due date of the batch task. YYY-MM-DD format, by default None.\nnotes : str, optional\n Notes associated with the batch task, by default None.\npriority : TaskPriority, optional\n The priority of the batch task, by default None.\nassigned_to : SerializeAsEntityLink[User], optional\n The user assigned to the batch task, by default None.\n\nstate : TaskState, optional\n The state of the batch task, by default None.\nsources : list[TaskSource], optional\n A list of sources associated with the batch task, by default an empty list.\nsecurity_class : SecurityClass, optional\n The security class of the batch task, by default None.\nstart_date : str, read only\n The start date of the batch task, by default None.\nclaimed_date : str, read only\n The claimed date of the batch task, by default None.\ncompleted_date : str, read only\n The completed date of the batch task, by default None.\nclosed_date : str, read only\n The closed date of the batch task, by default None.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"category": {
"const": "Property",
"default": "Property",
"title": "Category",
"type": "string"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Sources": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskSource"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sources"
},
"Inventories": {
"default": null,
"items": {
"$ref": "#/$defs/InventoryInformation"
},
"title": "Inventories",
"type": "array"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"priority": {
"anyOf": [
{
"$ref": "#/$defs/TaskPriority"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"passOrFail": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Passorfail"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"startDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Startdate"
},
"dueDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duedate"
},
"claimedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Claimeddate"
},
"completedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Completeddate"
},
"closedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closeddate"
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Result"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/TaskState"
},
{
"type": "null"
}
],
"default": null
},
"Project": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Project"
},
"AssignedTo": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignedto"
},
"PageState": {
"anyOf": [
{
"$ref": "#/$defs/PageState"
},
{
"type": "null"
}
],
"default": null
},
"Blocks": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Block"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Blocks"
},
"qcTask": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Qctask"
},
"batchTaskId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchtaskid"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
}
},
"required": [
"name"
],
"title": "PropertyTask",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
tags(list[SerializeAsEntityLink[Tag]] | None) -
id(str | None) -
name(str) -
parent_id(str | None) -
metadata(dict[str, MetadataItem]) -
sources(list[TaskSource] | None) -
inventory_information(list[InventoryInformation]) -
location(SerializeAsEntityLink[Location] | None) -
priority(TaskPriority | None) -
security_class(SecurityClass | None) -
pass_fail(bool | None) -
notes(str | None) -
start_date(str | None) -
due_date(str | None) -
claimed_date(str | None) -
completed_date(str | None) -
closed_date(str | None) -
result(str | None) -
state(TaskState | None) -
project(SerializeAsEntityLink[Project] | list[SerializeAsEntityLink[Project]] | None) -
assigned_to(SerializeAsEntityLink[User] | None) -
page_state(PageState | None) -
category(Literal[PROPERTY]) -
blocks(list[Block] | None) -
qc_task(bool | None) -
batch_task_id(str | None) -
target(str | None)
Bases: BaseTask
Represents a batch task.
This class is used to create and manage batch tasks. It includes the base task attributes and additional attributes specific to batch tasks.
Attributes:
| Name | Type | Description |
|---|---|---|
name |
str
|
The name of the batch task. |
inventory_information |
list[InventoryInformation]
|
Information about the inventory associated with the batch task. |
location |
SerializeAsEntityLink[Location]
|
The location where the batch task is performed. |
parent_id |
str
|
The ID of the parent project. |
id |
(str, optional)
|
The ID of the batch task, by default None. |
batch_size_unit |
(str, optional)
|
The unit of measurement for the batch size, by default None. |
metadata |
(dict[str, MetadataItem], optional)
|
Metadata associated with the batch task, by default an empty dictionary. |
workflows |
(list[SerializeAsEntityLink[Workflow]], optional)
|
A list of workflows associated with the batch task, by default None. |
due_date |
(str, optional)
|
The due date of the batch task. YYY-MM-DD format, by default None. |
notes |
(str, optional)
|
Notes associated with the batch task, by default None. |
priority |
(TaskPriority, optional)
|
The priority of the batch task, by default None. |
project |
(SerializeAsEntityLink[Project] | list[SerializeAsEntityLink[Project]], optional)
|
The project(s) associated with the batch task, by default None. |
assigned_to |
(SerializeAsEntityLink[User], optional)
|
The user assigned to the batch task, by default None. |
state |
(TaskState, optional)
|
The state of the batch task, by default None. |
sources |
(list[TaskSource], optional)
|
A list of sources associated with the batch task, by default an empty list. |
security_class |
(SecurityClass, optional)
|
The security class of the batch task, by default None. |
pass_fail |
(bool, optional)
|
Whether the batch task is pass/fail, by default None. |
start_date |
str, read only
|
The start date of the batch task, by default None. |
claimed_date |
str, read only
|
The claimed date of the batch task, by default None. |
completed_date |
str, read only
|
The completed date of the batch task, by default None. |
closed_date |
str, read only
|
The closed date of the batch task, by default None. |
qc_task |
(bool, optional)
|
Whether the batch task is a QC task, by default None. |
batch_task_id |
(str, optional)
|
The ID of the batch task, by default None. |
target |
(str, optional)
|
The target of the batch task, by default None. |
qc_task_data |
(list[QCTaskData], optional)
|
A list of QC task data associated with the batch task, by default None. |
Show JSON schema:
{
"$defs": {
"ACL": {
"description": "The Access Control List (ACL) for a user",
"properties": {
"id": {
"description": "The id of the user for which this ACL applies",
"title": "Id",
"type": "string"
},
"fgc": {
"anyOf": [
{
"$ref": "#/$defs/AccessControlLevel"
},
{
"type": "null"
}
],
"default": null,
"description": "The Fine-Grain Control Level"
}
},
"required": [
"id"
],
"title": "ACL",
"type": "object"
},
"AccessControlLevel": {
"description": "The fine grain control",
"enum": [
"ProjectOwner",
"ProjectEditor",
"ProjectViewer",
"ProjectAllTask",
"ProjectPropertyTask",
"InventoryOwner",
"InventoryViewer",
"CustomTemplateOwner"
],
"title": "AccessControlLevel",
"type": "string"
},
"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"
},
"BatchSizeUnit": {
"enum": [
"g",
"Kg",
"lbs"
],
"title": "BatchSizeUnit",
"type": "string"
},
"BlockLevelInventoryInformation": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
},
"BlockState": {
"properties": {
"id": {
"description": "The ID of the block.",
"title": "Id",
"type": "string"
},
"expand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Expand"
},
"Interval": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalId"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The IDs of the interval (e.g., id: ROW2XROW4)",
"title": "Interval"
},
"Inventory": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockLevelInventoryInformation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventory"
}
},
"required": [
"id"
],
"title": "BlockState",
"type": "object"
},
"Cas": {
"description": "Represents a CAS entity.",
"properties": {
"number": {
"description": "The CAS number.",
"title": "Number",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of the CAS.",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description or name of the CAS.",
"title": "Description"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Notes related to the CAS.",
"title": "Notes"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/CasCategory"
},
{
"type": "null"
}
],
"default": null,
"description": "The category of the CAS."
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "CAS SMILES notation.",
"title": "Cassmiles"
},
"inchiKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "InChIKey of the CAS.",
"title": "Inchikey"
},
"iUpacName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "IUPAC name of the CAS.",
"title": "Iupacname"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The AlbertID of the CAS.",
"title": "Albertid"
},
"hazards": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Hazard"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazards associated with the CAS.",
"title": "Hazards"
},
"wgk": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "German Water Hazard Class (WGK) number.",
"title": "Wgk"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "European Community (EC) number.",
"title": "Eclistno"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of the CAS.",
"title": "Type"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Classification type of the CAS.",
"title": "Classificationtype"
},
"order": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "CAS order.",
"title": "Order"
}
},
"required": [
"number"
],
"title": "Cas",
"type": "object"
},
"CasAmount": {
"description": "CasAmount is a Pydantic model representing an amount of a given CAS.\n\nAttributes\n----------\nmin : float\n The minimum amount of the CAS in the formulation.\nmax : float\n The maximum amount of the CAS in the formulation.\nid : str | None\n The Albert ID of the CAS Number Resource this amount represents. Provide either a Cas or an ID.\ncas : Cas | None\n The CAS object associated with this amount. Provide either a Cas or an id.\ncas_smiles: str | None\n The SMILES string of the CAS Number resource. Obtained from the Cas object when provided.\nnumber: str | None\n The CAS number. Obtained from the Cas object when provided.",
"properties": {
"min": {
"title": "Min",
"type": "number"
},
"max": {
"title": "Max",
"type": "number"
},
"inventoryValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventoryvalue"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"casCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cascategory"
},
"cas": {
"anyOf": [
{
"$ref": "#/$defs/Cas"
},
{
"type": "null"
}
],
"default": null
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cassmiles"
},
"number": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Number"
}
},
"required": [
"min",
"max"
],
"title": "CasAmount",
"type": "object"
},
"CasCategory": {
"enum": [
"User",
"Verisk",
"TSCA - Public",
"TSCA - Private",
"not TSCA",
"CAS linked to External Database",
"Unknown (Trade Secret)",
"CL_Inventory Upload"
],
"title": "CasCategory",
"type": "string"
},
"Company": {
"description": "Company is a Pydantic model representing a company entity.\n\nAttributes\n----------\nname : str\n The name of the company.\nid : str | None\n The Albert ID of the company. Set when the company is retrieved from Albert.\ndistance : float | None\n The scores of a company in a search result, optional. Read-only.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"distance": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Distance"
}
},
"required": [
"name"
],
"title": "Company",
"type": "object"
},
"DataType": {
"enum": [
"number",
"string",
"enum"
],
"title": "DataType",
"type": "string"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"EnumValidationValue": {
"description": "Represents a value for an enum type validation.\n\nAttributes\n----------\ntext : str\n The text of the enum value.\nid : str | None\n The ID of the enum value. If not provided, the ID will be generated upon creation.",
"properties": {
"text": {
"title": "Text",
"type": "string"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"originalText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originaltext"
}
},
"required": [
"text"
],
"title": "EnumValidationValue",
"type": "object"
},
"GridDefault": {
"description": "The default grid for a project",
"enum": [
"PD",
"WKS"
],
"title": "GridDefault",
"type": "string"
},
"Hazard": {
"description": "Represents a chemical hazard.",
"properties": {
"subCategory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard subcategory",
"title": "Subcategory"
},
"hCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard code",
"title": "Hcode"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard category",
"title": "Category"
},
"class": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard classification",
"title": "Class"
},
"hCodeText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hazard code text",
"title": "Hcodetext"
}
},
"title": "Hazard",
"type": "object"
},
"Interval": {
"description": "A Pydantic class representing an interval.\n\nAttrubutes\n----------\nvalue : str\n The value of the interval setpoint.\nunit : Unit\n The unit of the related value.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rowid"
}
},
"title": "Interval",
"type": "object"
},
"IntervalCombination": {
"description": "A class representing the interval combinations of on a workflow.\nThis is returned by the workflow endpoint when at least one parameter\nin the workflow has been intervalized.\n\nInterval Combinations can be single intervalized parameters or cartesian prodcuts of\ntwo intervalized parameters.\n\nAttributes\n----------\ninterval_id: IntervalId | None\n forign key reference to the interval id\n this combination is associated with\n It will have the form ROW# or ROW#XROW# depending on\n if it is a single interval or a product of two intervals\ninterval_params: str | None\n The parameters participating in the interval.\ninterval_string: str | None\n The string representation of the interval combination\n This will have the form \"[Parameter Name]: [Parameter Value] [Parameter Unit]\"\n for each parameter in the interval combination",
"properties": {
"interval": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Interval"
},
"intervalParams": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalparams"
},
"intervalString": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalstring"
}
},
"title": "IntervalCombination",
"type": "object"
},
"IntervalId": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "IntervalId",
"type": "object"
},
"InventoryCategory": {
"enum": [
"RawMaterials",
"Consumables",
"Equipment",
"Formulas"
],
"title": "InventoryCategory",
"type": "string"
},
"InventoryInformation": {
"description": "Represents the Inventory information needed for a task. For a Batch task, inventory_id and batch_size are required.\nFor Property and general tasks, inventory_id and lot_id is recomended is required.\n\nAttributes\n----------\ninventory_id : str\n The inventory id of the item to be used in the task.\nlot_id : str, optional\n The lot id of the item to be used in the task. Reccomended for Property and General tasks.\nbatch_size : float, Required for Batch tasks, otherwise optional.\n The batch size to make of the related InventoryItem. Required for Batch tasks.\nselected_lot : bool, read only\n Whether the lot is selected for the task. Default is None.",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
},
"batchSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchsize"
},
"selectedLot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Selectedlot"
},
"barcodeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Barcodeid"
},
"quantityUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Quantityused"
}
},
"required": [
"id"
],
"title": "InventoryInformation",
"type": "object"
},
"InventoryItem": {
"description": "An InventoryItem is a Pydantic model representing an item in the inventory. Can be a raw material, consumable, equipment, or formula.\nNote: Formulas should be registered via the Worksheet collection / Sheet resource.\n\nReturns\n-------\nInventoryItem\n An InventoryItem that can be used to represent an item in the inventory. Can be a raw material, consumable, equipment, or formula.\n\nAttributes\n------\n\nname : str\n The name of the InventoryItem.\nid : str | None\n The Albert ID of the InventoryItem. Set when the InventoryItem is retrieved from Albert.\ndescription : str | None\n The description of the InventoryItem.\ncategory : InventoryCategory\n The category of the InventoryItem. Allowed values are `RawMaterials`, `Consumables`, `Equipment`, and `Formulas`.\nunit_category : InventoryUnitCategory\n The unit category of the InventoryItem. Can be mass, volume, length, pressure, or units. By default, mass is used for RawMaterials and Formulas, and units is used for Equipment and Consumables.\nsecurity_class : SecurityClass | None\n The security class of the InventoryItem. Optional. Can be confidential, shared, or restricted.\ncompany : Company | str | None\n The company associated with the InventoryItem. Can be a Company object or a string. If a String is provided, a Company object with the name of the provided string will be first-or-created.\nminimum : list[InventoryMinimum] | None\n The minimum amount of the InventoryItem that must be kept in stock at a given Location. Optional.\nalias : str | None\n An alias for the InventoryItem. Optional.\ncas : list[CasAmount] | None\n The CAS numbers associated with the InventoryItem. This is how a compositional breakdown can be provided. Optional.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n Metadata associated with the InventoryItem. Optional. Allowed metadata fields can be found in the CustomFields documentation.\nproject_id : str | None\n The project ID associated with the InventoryItem. Read Only. Required for Formulas.\nformula_id : str | None\n The formula ID associated with the InventoryItem. Read Only.\ntags : list[str|Tag] | None\n The tags associated with the InventoryItem. Optional. If a string is provided, a Tag object with the name of the provided string will be first-or-created.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"category": {
"$ref": "#/$defs/InventoryCategory"
},
"unitCategory": {
"anyOf": [
{
"$ref": "#/$defs/InventoryUnitCategory"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"Company": {
"anyOf": [
{
"$ref": "#/$defs/Company"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Company"
},
"minimum": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/InventoryMinimum"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Minimum"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Alias"
},
"Cas": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CasAmount"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Cas"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"ACL": {
"items": {
"$ref": "#/$defs/ACL"
},
"title": "Acl",
"type": "array"
},
"TaskConfig": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskconfig"
},
"formulaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Formulaid"
},
"Symbols": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Symbols"
},
"unNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unnumber"
},
"recentAttachmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Recentattachmentid"
}
},
"required": [
"category"
],
"title": "InventoryItem",
"type": "object"
},
"InventoryMinimum": {
"description": "Defined the minimum amount of an InventoryItem that must be kept in stock at a given Location.\n\nAttributes\n----------\nid : str\n The unique identifier of the Location object associated with this InventoryMinimum.\n Provide either a Location or a location id.\nlocation : Location\n The Location object associated with this InventoryMinimum. Provide either a Location or a location id.\nminimum : float\n The minimum amount of the InventoryItem that must be kept in stock at the given Location.",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"type": "null"
}
],
"default": null
},
"minimum": {
"maximum": 1000000000000000,
"minimum": 0,
"title": "Minimum",
"type": "number"
}
},
"required": [
"minimum"
],
"title": "InventoryMinimum",
"type": "object"
},
"InventoryUnitCategory": {
"enum": [
"mass",
"volume",
"length",
"pressure",
"units"
],
"title": "InventoryUnitCategory",
"type": "string"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"Operator": {
"enum": [
"between",
"lt",
"lte",
"gte",
"gt",
"eq"
],
"title": "Operator",
"type": "string"
},
"PGType": {
"description": "The type of a parameter group",
"enum": [
"general",
"batch",
"property"
],
"title": "PGType",
"type": "string"
},
"PageState": {
"properties": {
"leftPanelExpand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Leftpanelexpand"
},
"Block": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockState"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Block"
}
},
"title": "PageState",
"type": "object"
},
"Parameter": {
"description": "A parameter in Albert.\n\nAttributes\n----------\nname : str\n The name of the parameter. Names must be unique.\nid : str | None\n The Albert ID of the parameter. Set when the parameter is retrieved from Albert.\ncategory : ParameterCategory\n The category of the parameter. Allowed values are `Normal` and `Special`. Read-only.\nrank : int\n The rank of the returned parameter. Read-only.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"rank": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Rank"
}
},
"required": [
"name"
],
"title": "Parameter",
"type": "object"
},
"ParameterCategory": {
"description": "The category of a parameter",
"enum": [
"Normal",
"Special"
],
"title": "ParameterCategory",
"type": "string"
},
"ParameterGroup": {
"description": "Use 'Standards' key in metadata to store standards",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"name": {
"title": "Name",
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/$defs/PGType"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"class": {
"$ref": "#/$defs/SecurityClass",
"default": "restricted"
},
"ACL": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Acl"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Parameters": {
"items": {
"$ref": "#/$defs/ParameterValue"
},
"title": "Parameters",
"type": "array"
},
"verified": {
"default": false,
"title": "Verified",
"type": "boolean"
},
"documents": {
"items": {
"$ref": "#/$defs/EntityLink"
},
"title": "Documents",
"type": "array"
}
},
"required": [
"name"
],
"title": "ParameterGroup",
"type": "object"
},
"ParameterGroupSetpoints": {
"description": "A class that represents the setpoints on a parameter group.\n\n\nAttributes\n----------\nparameter_group : ParameterGroup\n The parameter group to set the setpoints on. Provide either a parameter_group or a paramerter_group_id\nparameter_group_id : ParameterGroupId\n The id of the parameter group. Provide either a parameter_group or a paramerter_group_id\nparameter_group_name : str\n The name of the parameter group. This is a read-only field.\nparameter_setpoints : list[ParameterSetpoint]\n The setpoints to apply to the parameter group.",
"properties": {
"parameter_group": {
"anyOf": [
{
"$ref": "#/$defs/ParameterGroup"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"Parameters": {
"items": {
"$ref": "#/$defs/ParameterSetpoint"
},
"title": "Parameters",
"type": "array"
}
},
"title": "ParameterGroupSetpoints",
"type": "object"
},
"ParameterSetpoint": {
"description": "A Pydantic class representing the setpoint or intervals of a parameter to use.\nFor a single value, provide the value and unit. For multiple values, provide intervals.\na parameter or parameter_id must be provided.\n\nAttributes\n----------\nparameter : Parameter\n The parameter to set the setpoint on. Provide either a parameter or a parameter_id.\nparameter_id : ParameterId\n The id of the parameter. Provide either a parameter or a parameter_id.\nvalue : str | EntityLink\n The value of the setpoint. If the parameter is a InventoryItem, provide the EntityLink of the InventoryItem.\nunit : Unit\n The unit of the setpoint.\nintervals : list[Interval]\n The intervals of the setpoint. Either ether intervals or value + unit\ncategory : ParameterCategory\n The category of the parameter. Special for InventoryItem (then use name to specify \"Equipment\", \"Consumeable\", etc), normal for all others\nshort_name : str\n The short / display name of the parameter. Required if value is a dictionary.\nrow_id : RowId\n The id of the parameter with respect to the interval row id.",
"properties": {
"parameter": {
"anyOf": [
{
"$ref": "#/$defs/Parameter"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"Intervals": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Interval"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervals"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shortname"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"rowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Rowid"
}
},
"title": "ParameterSetpoint",
"type": "object"
},
"ParameterValue": {
"description": "The value of a parameter in a parameter group.\n\nAttributes\n----------\nparameter : Parameter\n The Parameter resource this value is associated with. Provide either an id or a parameter keyword argument.\nid : str | None\n The Albert ID of the Parameter resource this value is associated with. Provide either an id or a parameter keyword argument.\ncategory: ParameterCategory\n The category of the parameter.\nshort_name : str | None\n The short name of the parameter value.\nvalue : str | None\n The default value of the parameter. Can be a string or an InventoryItem (if, for example, the parameter is an instrumnt choice).\nunit : Unit | None\n The unit of measure for the provided parameter value.\nname : str\n The name of the parameter. Read-only.\nsequence : int\n The sequence of the parameter. Read-only.",
"properties": {
"parameter": {
"$ref": "#/$defs/Parameter",
"default": null
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/ParameterCategory"
},
{
"type": "null"
}
],
"default": null
},
"shortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Shortname"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/InventoryItem"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"Unit": {
"anyOf": [
{
"$ref": "#/$defs/Unit"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit"
},
"Added": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"validation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ValueValidation"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Validation"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"sequence": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sequence"
},
"originalShortName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originalshortname"
},
"originalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Originalname"
}
},
"title": "ParameterValue",
"type": "object"
},
"Project": {
"description": "A project in Albert.\n\nAttributes\n----------\ndescription : str\n The description of the project. Used as the name of the project as well.\nid : str | None\n The Albert ID of the project. Set when the project is retrieved from Albert.\nlocations : list[Location] | None\n The locations associated with the project. Optional.\nproject_class : ProjectClass\n The class of the project. Defaults to PRIVATE.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n The metadata of the project. Optional. Metadata allowed values can be found using the Custom Fields API.\nprefix : str | None\n The prefix of the project. Optional.\n\nacl : list[ACL] | None\n The ACL of the project. Optional.\ntask_config : list[TaskConfig] | None\n The task configuration of the project. Optional.\ngrid : GridDefault | None\n The default grid of the project. Optional.\nstate : State | None\n The state/status of the project. Allowed states are customizeable using the entitystatus API. Optional.\napplication_engineering_inventory_ids : list[str] | None\n Inventory Ids to be added as application engineering. Optional.",
"properties": {
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"maxLength": 2000,
"minLength": 1,
"title": "Description",
"type": "string"
},
"Locations": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Locations"
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/ProjectClass"
},
{
"type": "null"
}
],
"default": "private"
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prefix"
},
"appEngg": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Inventory Ids to be added as application engineering",
"title": "Appengg"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"ACL": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ACL"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acl"
},
"old_api_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Old Api Params"
},
"task_config": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskConfig"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Task Config"
},
"grid": {
"anyOf": [
{
"$ref": "#/$defs/GridDefault"
},
{
"type": "null"
}
],
"default": null
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/State"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"description"
],
"title": "Project",
"type": "object"
},
"ProjectClass": {
"description": "The ACL Class of a project",
"enum": [
"shared",
"public",
"confidential",
"private"
],
"title": "ProjectClass",
"type": "string"
},
"QCTarget": {
"properties": {
"formulaId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Formulaid"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
}
},
"title": "QCTarget",
"type": "object"
},
"QCTaskData": {
"properties": {
"datatemplateId": {
"title": "Datatemplateid",
"type": "string"
},
"Workflows": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/QCWorkflowTargets"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflows"
}
},
"required": [
"datatemplateId"
],
"title": "QCTaskData",
"type": "object"
},
"QCWorkflowTargets": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"taskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Taskname"
},
"Targets": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/QCTarget"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Targets"
}
},
"title": "QCWorkflowTargets",
"type": "object"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"SecurityClass": {
"description": "The security class of a resource",
"enum": [
"shared",
"restricted",
"confidential",
"private",
"public"
],
"title": "SecurityClass",
"type": "string"
},
"State": {
"description": "The current state of a project",
"enum": [
"Not Started",
"Active",
"Closed - Success",
"Closed - Archived"
],
"title": "State",
"type": "string"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"Tag": {
"description": "Tag is a Pydantic model representing a tag entity.\n\nAttributes\n----------\ntag : str\n The name of the tag.\nid : str | None\n The Albert ID of the tag. Set when the tag is retrieved from Albert.\n\nMethods\n-------\nfrom_string(tag: str) -> \"Tag\"\n Creates a Tag object from a string.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name"
],
"title": "Tag",
"type": "object"
},
"TaskConfig": {
"description": "The task configuration for a project",
"properties": {
"datatemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datatemplateid"
},
"workflowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflowid"
},
"defaultTaskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Defaulttaskname"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"hidden": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Hidden"
}
},
"title": "TaskConfig",
"type": "object"
},
"TaskPriority": {
"enum": [
"High",
"Medium",
"Low"
],
"title": "TaskPriority",
"type": "string"
},
"TaskSource": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"type": {
"$ref": "#/$defs/TaskSourceType"
}
},
"required": [
"id",
"type"
],
"title": "TaskSource",
"type": "object"
},
"TaskSourceType": {
"enum": [
"task",
"template"
],
"title": "TaskSourceType",
"type": "string"
},
"TaskState": {
"enum": [
"Unclaimed",
"Not Started",
"In Progress",
"Completed",
"Closed"
],
"title": "TaskState",
"type": "string"
},
"Unit": {
"description": "Unit is a Pydantic model representing a unit entity.\n\nAttributes\n----------\nid : str | None\n The Albert ID of the unit. Set when the unit is retrieved from Albert.\nname : str\n The name of the unit.\nsymbol : str | None\n The symbol of the unit.\nsynonyms : List[str] | None\n The list of synonyms for the unit.\ncategory : UnitCategory\n The category of the unit.\nverified : bool | None\n Whether the unit is verified.\nstatus : Status | None\n The status of the unit. Allowed values are `active`, and `inactive`",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Symbol"
},
"Synonyms": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Synonyms"
},
"category": {
"anyOf": [
{
"$ref": "#/$defs/UnitCategory"
},
{
"type": "null"
}
],
"default": null
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Verified"
}
},
"required": [
"name"
],
"title": "Unit",
"type": "object"
},
"UnitCategory": {
"description": "UnitCategory is an enumeration of possible unit categories.\n\nAttributes\n----------\nLENGTH : str\n Represents length units.\nVOLUME : str\n Represents volume units.\nLIQUID_VOLUME : str\n Represents liquid volume units.\nANGLES : str\n Represents angle units.\nTIME : str\n Represents time units.\nFREQUENCY : str\n Represents frequency units.\nMASS : str\n Represents mass units.\nCURRENT : str\n Represents electric current units.\nTEMPERATURE : str\n Represents temperature units.\nAMOUNT : str\n Represents amount of substance units.\nLUMINOSITY : str\n Represents luminous intensity units.\nFORCE : str\n Represents force units.\nENERGY : str\n Represents energy units.\nPOWER : str\n Represents power units.\nPRESSURE : str\n Represents pressure units.\nELECTRICITY_AND_MAGNETISM : str\n Represents electricity and magnetism units.\nOTHER : str\n Represents other units.\nWEIGHT : str\n Represents weight units.",
"enum": [
"Length",
"Volume",
"Liquid volume",
"Angles",
"Time",
"Frequency",
"Mass",
"Electric current",
"Temperature",
"Amount of substance",
"Luminous intensity",
"Force",
"Energy",
"Power",
"Pressure",
"Electricity and magnetism",
"Other",
"Weight",
"Area",
"Surface Area",
"Binary",
"Capacitance",
"Speed",
"Electrical conductivity",
"Electrical permitivitty",
"Density",
"Resistance"
],
"title": "UnitCategory",
"type": "string"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
},
"ValueValidation": {
"properties": {
"datatype": {
"$ref": "#/$defs/DataType"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/$defs/EnumValidationValue"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Value"
},
"min": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Max"
},
"operator": {
"anyOf": [
{
"$ref": "#/$defs/Operator"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"datatype"
],
"title": "ValueValidation",
"type": "object"
},
"Workflow": {
"description": "A Pydantic Class representing a workflow in Albert.\n\nWorkflows are combinations of Data Templates and Parameter groups and their associated setpoints.\n\nAttributes\n----------\nname : str\n The name of the workflow.\nparameter_group_setpoints : list[ParameterGroupSetpoints]\n The setpoints to apply to the parameter groups in the workflow.\nid : str | None\n The AlbertID of the workflow. This is set when a workflow is retrived from the platform.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"ParameterGroups": {
"items": {
"$ref": "#/$defs/ParameterGroupSetpoints"
},
"title": "Parametergroups",
"type": "array"
},
"IntervalCombinations": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalCombination"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Intervalcombinations"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name",
"ParameterGroups"
],
"title": "Workflow",
"type": "object"
}
},
"description": "Represents a batch task.\n\nThis class is used to create and manage batch tasks. It includes the base task attributes\nand additional attributes specific to batch tasks.\n\nAttributes\n----------\nname : str\n The name of the batch task.\ninventory_information : list[InventoryInformation]\n Information about the inventory associated with the batch task.\nlocation : SerializeAsEntityLink[Location]\n The location where the batch task is performed.\nparent_id : str\n The ID of the parent project.\nid : str, optional\n The ID of the batch task, by default None.\n\nbatch_size_unit : str, optional\n The unit of measurement for the batch size, by default None.\nmetadata : dict[str, MetadataItem], optional\n Metadata associated with the batch task, by default an empty dictionary.\nworkflows : list[SerializeAsEntityLink[Workflow]], optional\n A list of workflows associated with the batch task, by default None.\ndue_date : str, optional\n The due date of the batch task. YYY-MM-DD format, by default None.\nnotes : str, optional\n Notes associated with the batch task, by default None.\npriority : TaskPriority, optional\n The priority of the batch task, by default None.\nproject : SerializeAsEntityLink[Project] | list[SerializeAsEntityLink[Project]], optional\n The project(s) associated with the batch task, by default None.\nassigned_to : SerializeAsEntityLink[User], optional\n The user assigned to the batch task, by default None.\n\nstate : TaskState, optional\n The state of the batch task, by default None.\nsources : list[TaskSource], optional\n A list of sources associated with the batch task, by default an empty list.\nsecurity_class : SecurityClass, optional\n The security class of the batch task, by default None.\npass_fail : bool, optional\n Whether the batch task is pass/fail, by default None.\nstart_date : str, read only\n The start date of the batch task, by default None.\nclaimed_date : str, read only\n The claimed date of the batch task, by default None.\ncompleted_date : str, read only\n The completed date of the batch task, by default None.\nclosed_date : str, read only\n The closed date of the batch task, by default None.\nqc_task : bool, optional\n Whether the batch task is a QC task, by default None.\nbatch_task_id : str, optional\n The ID of the batch task, by default None.\ntarget : str, optional\n The target of the batch task, by default None.\nqc_task_data : list[QCTaskData], optional\n A list of QC task data associated with the batch task, by default None.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"category": {
"default": "Batch",
"enum": [
"Batch",
"BatchWithQC"
],
"title": "Category",
"type": "string"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Sources": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskSource"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sources"
},
"Inventories": {
"default": null,
"items": {
"$ref": "#/$defs/InventoryInformation"
},
"title": "Inventories",
"type": "array"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"priority": {
"anyOf": [
{
"$ref": "#/$defs/TaskPriority"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"passOrFail": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Passorfail"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"startDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Startdate"
},
"dueDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duedate"
},
"claimedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Claimeddate"
},
"completedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Completeddate"
},
"closedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closeddate"
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Result"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/TaskState"
},
{
"type": "null"
}
],
"default": null
},
"Project": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Project"
},
"AssignedTo": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignedto"
},
"PageState": {
"anyOf": [
{
"$ref": "#/$defs/PageState"
},
{
"type": "null"
}
],
"default": null
},
"batchSizeUnit": {
"anyOf": [
{
"$ref": "#/$defs/BatchSizeUnit"
},
{
"type": "null"
}
],
"default": null
},
"qcTask": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Qctask"
},
"batchTaskId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchtaskid"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"QCTaskData": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/QCTaskData"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Qctaskdata"
},
"Workflow": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Workflow"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflow"
}
},
"required": [
"name"
],
"title": "BatchTask",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
tags(list[SerializeAsEntityLink[Tag]] | None) -
id(str | None) -
name(str) -
parent_id(str | None) -
metadata(dict[str, MetadataItem]) -
sources(list[TaskSource] | None) -
inventory_information(list[InventoryInformation]) -
location(SerializeAsEntityLink[Location] | None) -
priority(TaskPriority | None) -
security_class(SecurityClass | None) -
pass_fail(bool | None) -
notes(str | None) -
start_date(str | None) -
due_date(str | None) -
claimed_date(str | None) -
completed_date(str | None) -
closed_date(str | None) -
result(str | None) -
state(TaskState | None) -
project(SerializeAsEntityLink[Project] | list[SerializeAsEntityLink[Project]] | None) -
assigned_to(SerializeAsEntityLink[User] | None) -
page_state(PageState | None) -
category(Literal[BATCH, BATCH_WITH_QC]) -
batch_size_unit(BatchSizeUnit | None) -
qc_task(bool | None) -
batch_task_id(str | None) -
target(str | None) -
qc_task_data(list[QCTaskData] | None) -
workflows(list[SerializeAsEntityLink[Workflow]] | None)
Bases: BaseTask
Show JSON schema:
{
"$defs": {
"ACL": {
"description": "The Access Control List (ACL) for a user",
"properties": {
"id": {
"description": "The id of the user for which this ACL applies",
"title": "Id",
"type": "string"
},
"fgc": {
"anyOf": [
{
"$ref": "#/$defs/AccessControlLevel"
},
{
"type": "null"
}
],
"default": null,
"description": "The Fine-Grain Control Level"
}
},
"required": [
"id"
],
"title": "ACL",
"type": "object"
},
"AccessControlLevel": {
"description": "The fine grain control",
"enum": [
"ProjectOwner",
"ProjectEditor",
"ProjectViewer",
"ProjectAllTask",
"ProjectPropertyTask",
"InventoryOwner",
"InventoryViewer",
"CustomTemplateOwner"
],
"title": "AccessControlLevel",
"type": "string"
},
"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"
},
"BlockLevelInventoryInformation": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
}
},
"required": [
"id"
],
"title": "BlockLevelInventoryInformation",
"type": "object"
},
"BlockState": {
"properties": {
"id": {
"description": "The ID of the block.",
"title": "Id",
"type": "string"
},
"expand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Expand"
},
"Interval": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IntervalId"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The IDs of the interval (e.g., id: ROW2XROW4)",
"title": "Interval"
},
"Inventory": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockLevelInventoryInformation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Inventory"
}
},
"required": [
"id"
],
"title": "BlockState",
"type": "object"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"GridDefault": {
"description": "The default grid for a project",
"enum": [
"PD",
"WKS"
],
"title": "GridDefault",
"type": "string"
},
"IntervalId": {
"properties": {
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "IntervalId",
"type": "object"
},
"InventoryInformation": {
"description": "Represents the Inventory information needed for a task. For a Batch task, inventory_id and batch_size are required.\nFor Property and general tasks, inventory_id and lot_id is recomended is required.\n\nAttributes\n----------\ninventory_id : str\n The inventory id of the item to be used in the task.\nlot_id : str, optional\n The lot id of the item to be used in the task. Reccomended for Property and General tasks.\nbatch_size : float, Required for Batch tasks, otherwise optional.\n The batch size to make of the related InventoryItem. Required for Batch tasks.\nselected_lot : bool, read only\n Whether the lot is selected for the task. Default is None.",
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"lotId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lotid"
},
"invLotUniqueId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Invlotuniqueid"
},
"batchSize": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Batchsize"
},
"selectedLot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Selectedlot"
},
"barcodeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Barcodeid"
},
"quantityUsed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Quantityused"
}
},
"required": [
"id"
],
"title": "InventoryInformation",
"type": "object"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"PageState": {
"properties": {
"leftPanelExpand": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Leftpanelexpand"
},
"Block": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BlockState"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Block"
}
},
"title": "PageState",
"type": "object"
},
"Project": {
"description": "A project in Albert.\n\nAttributes\n----------\ndescription : str\n The description of the project. Used as the name of the project as well.\nid : str | None\n The Albert ID of the project. Set when the project is retrieved from Albert.\nlocations : list[Location] | None\n The locations associated with the project. Optional.\nproject_class : ProjectClass\n The class of the project. Defaults to PRIVATE.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None\n The metadata of the project. Optional. Metadata allowed values can be found using the Custom Fields API.\nprefix : str | None\n The prefix of the project. Optional.\n\nacl : list[ACL] | None\n The ACL of the project. Optional.\ntask_config : list[TaskConfig] | None\n The task configuration of the project. Optional.\ngrid : GridDefault | None\n The default grid of the project. Optional.\nstate : State | None\n The state/status of the project. Allowed states are customizeable using the entitystatus API. Optional.\napplication_engineering_inventory_ids : list[str] | None\n Inventory Ids to be added as application engineering. Optional.",
"properties": {
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"description": {
"maxLength": 2000,
"minLength": 1,
"title": "Description",
"type": "string"
},
"Locations": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Locations"
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/ProjectClass"
},
{
"type": "null"
}
],
"default": "private"
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Prefix"
},
"appEngg": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Inventory Ids to be added as application engineering",
"title": "Appengg"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"ACL": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ACL"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Acl"
},
"old_api_params": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Old Api Params"
},
"task_config": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskConfig"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Task Config"
},
"grid": {
"anyOf": [
{
"$ref": "#/$defs/GridDefault"
},
{
"type": "null"
}
],
"default": null
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/State"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"description"
],
"title": "Project",
"type": "object"
},
"ProjectClass": {
"description": "The ACL Class of a project",
"enum": [
"shared",
"public",
"confidential",
"private"
],
"title": "ProjectClass",
"type": "string"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"SecurityClass": {
"description": "The security class of a resource",
"enum": [
"shared",
"restricted",
"confidential",
"private",
"public"
],
"title": "SecurityClass",
"type": "string"
},
"State": {
"description": "The current state of a project",
"enum": [
"Not Started",
"Active",
"Closed - Success",
"Closed - Archived"
],
"title": "State",
"type": "string"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"Tag": {
"description": "Tag is a Pydantic model representing a tag entity.\n\nAttributes\n----------\ntag : str\n The name of the tag.\nid : str | None\n The Albert ID of the tag. Set when the tag is retrieved from Albert.\n\nMethods\n-------\nfrom_string(tag: str) -> \"Tag\"\n Creates a Tag object from a string.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
}
},
"required": [
"name"
],
"title": "Tag",
"type": "object"
},
"TaskConfig": {
"description": "The task configuration for a project",
"properties": {
"datatemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Datatemplateid"
},
"workflowId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workflowid"
},
"defaultTaskName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Defaulttaskname"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Target"
},
"hidden": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": false,
"title": "Hidden"
}
},
"title": "TaskConfig",
"type": "object"
},
"TaskPriority": {
"enum": [
"High",
"Medium",
"Low"
],
"title": "TaskPriority",
"type": "string"
},
"TaskSource": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"type": {
"$ref": "#/$defs/TaskSourceType"
}
},
"required": [
"id",
"type"
],
"title": "TaskSource",
"type": "object"
},
"TaskSourceType": {
"enum": [
"task",
"template"
],
"title": "TaskSourceType",
"type": "string"
},
"TaskState": {
"enum": [
"Unclaimed",
"Not Started",
"In Progress",
"Completed",
"Closed"
],
"title": "TaskState",
"type": "string"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
}
},
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Tags": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Tag"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"category": {
"const": "General",
"default": "General",
"title": "Category",
"type": "string"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parentid"
},
"Metadata": {
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"title": "Metadata",
"type": "object"
},
"Sources": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/TaskSource"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Sources"
},
"Inventories": {
"default": null,
"items": {
"$ref": "#/$defs/InventoryInformation"
},
"title": "Inventories",
"type": "array"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"priority": {
"anyOf": [
{
"$ref": "#/$defs/TaskPriority"
},
{
"type": "null"
}
],
"default": null
},
"class": {
"anyOf": [
{
"$ref": "#/$defs/SecurityClass"
},
{
"type": "null"
}
],
"default": null
},
"passOrFail": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Passorfail"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"startDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Startdate"
},
"dueDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Duedate"
},
"claimedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Claimeddate"
},
"completedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Completeddate"
},
"closedDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Closeddate"
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Result"
},
"state": {
"anyOf": [
{
"$ref": "#/$defs/TaskState"
},
{
"type": "null"
}
],
"default": null
},
"Project": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"anyOf": [
{
"$ref": "#/$defs/Project"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Project"
},
"AssignedTo": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Assignedto"
},
"PageState": {
"anyOf": [
{
"$ref": "#/$defs/PageState"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name"
],
"title": "GeneralTask",
"type": "object"
}
Fields:
-
status(Status | None) -
created(AuditFields | None) -
updated(AuditFields | None) -
tags(list[SerializeAsEntityLink[Tag]] | None) -
id(str | None) -
name(str) -
parent_id(str | None) -
metadata(dict[str, MetadataItem]) -
sources(list[TaskSource] | None) -
inventory_information(list[InventoryInformation]) -
location(SerializeAsEntityLink[Location] | None) -
priority(TaskPriority | None) -
security_class(SecurityClass | None) -
pass_fail(bool | None) -
notes(str | None) -
start_date(str | None) -
due_date(str | None) -
claimed_date(str | None) -
completed_date(str | None) -
closed_date(str | None) -
result(str | None) -
state(TaskState | None) -
project(SerializeAsEntityLink[Project] | list[SerializeAsEntityLink[Project]] | None) -
assigned_to(SerializeAsEntityLink[User] | None) -
page_state(PageState | None) -
category(Literal[GENERAL])
Bases: BaseAlbertModel
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"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
}
},
"properties": {
"state": {
"title": "State",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"actionAt": {
"format": "date-time",
"title": "Actionat",
"type": "string"
},
"User": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
],
"title": "User"
},
"oldValue": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Oldvalue"
},
"newValue": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Newvalue"
}
},
"required": [
"state",
"action",
"actionAt",
"User"
],
"title": "TaskHistoryEvent",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
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"
},
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"Location": {
"description": "A location in Albert.\n\nAttributes\n----------\nname : str\n The name of the location.\nid : str | None\n The Albert ID of the location. Set when the location is retrieved from Albert.\nlatitude : float\n The latitude of the location.\nlongitude : float\n The longitude of the location.\naddress : str\n The address of the location.\ncountry : str | None\n The country code of the location. Must be two characters long.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"latitude": {
"title": "Latitude",
"type": "number"
},
"longitude": {
"title": "Longitude",
"type": "number"
},
"address": {
"title": "Address",
"type": "string"
},
"country": {
"anyOf": [
{
"maxLength": 2,
"minLength": 2,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Country"
}
},
"required": [
"name",
"latitude",
"longitude",
"address"
],
"title": "Location",
"type": "object"
},
"Role": {
"description": "A role in Albert. Note: Roles are not currently creatable via the SDK.\n\nAttributes\n----------\nname : str\n The name of the role.\nid : str\n The Albert ID of the role. Set when the role is retrieved from Albert.\npolicies : list[Any] | None\n The policies associated with the role.\ntenant : str\n The tenant ID of the role.",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"name": {
"title": "Name",
"type": "string"
},
"policies": {
"anyOf": [
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Policies"
},
"tenant": {
"title": "Tenant",
"type": "string"
}
},
"required": [
"name",
"tenant"
],
"title": "Role",
"type": "object"
},
"Status": {
"description": "The status of a resource",
"enum": [
"active",
"inactive"
],
"title": "Status",
"type": "string"
},
"TaskHistoryEvent": {
"properties": {
"state": {
"title": "State",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"actionAt": {
"format": "date-time",
"title": "Actionat",
"type": "string"
},
"User": {
"anyOf": [
{
"$ref": "#/$defs/User"
},
{
"$ref": "#/$defs/EntityLink"
}
],
"title": "User"
},
"oldValue": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Oldvalue"
},
"newValue": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Newvalue"
}
},
"required": [
"state",
"action",
"actionAt",
"User"
],
"title": "TaskHistoryEvent",
"type": "object"
},
"User": {
"description": "Represents a User on the Albert Platform\n\nAttributes\n----------\nname : str\n The name of the user.\nid : str | None\n The Albert ID of the user. Set when the user is retrieved from Albert.\nlocation : Location | None\n The location of the user.\nemail : EmailStr | None\n The email of the user.\nroles : list[Role]\n The roles of the user.\nuser_class : UserClass\n The ACL class level of the user.\nmetadata : dict[str, str | list[EntityLink] | EntityLink] | None",
"properties": {
"status": {
"anyOf": [
{
"$ref": "#/$defs/Status"
},
{
"type": "null"
}
],
"default": null
},
"Created": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"Updated": {
"anyOf": [
{
"$ref": "#/$defs/AuditFields"
},
{
"type": "null"
}
],
"default": null
},
"name": {
"title": "Name",
"type": "string"
},
"albertId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Albertid"
},
"Location": {
"anyOf": [
{
"$ref": "#/$defs/Location"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"type": "null"
}
],
"default": null,
"title": "Location"
},
"email": {
"default": null,
"format": "email",
"title": "Email",
"type": "string"
},
"Roles": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Role"
},
{
"$ref": "#/$defs/EntityLink"
}
]
},
"maxItems": 1,
"title": "Roles",
"type": "array"
},
"userClass": {
"$ref": "#/$defs/UserClass",
"default": "standard"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"name"
],
"title": "User",
"type": "object"
},
"UserClass": {
"description": "The ACL class level of the user",
"enum": [
"guest",
"standard",
"trusted",
"privileged",
"admin"
],
"title": "UserClass",
"type": "string"
}
},
"properties": {
"Items": {
"items": {
"$ref": "#/$defs/TaskHistoryEvent"
},
"title": "Items",
"type": "array"
}
},
"required": [
"Items"
],
"title": "TaskHistory",
"type": "object"
}
Fields:
Bases: PatchPayload
A payload for a PATCH request to update a Task.
Attributes:
| Name | Type | Description |
|---|---|---|
id |
str
|
The id of the Task to be updated. |
Show JSON schema:
{
"$defs": {
"PatchDatum": {
"properties": {
"operation": {
"title": "Operation",
"type": "string"
},
"attribute": {
"title": "Attribute",
"type": "string"
},
"newValue": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Newvalue"
},
"oldValue": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"title": "Oldvalue"
}
},
"required": [
"operation",
"attribute"
],
"title": "PatchDatum",
"type": "object"
}
},
"description": "A payload for a PATCH request to update a Task.\n\nAttributes\n----------\nid: str\n The id of the Task to be updated.",
"properties": {
"data": {
"items": {
"$ref": "#/$defs/PatchDatum"
},
"title": "Data",
"type": "array"
},
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"data",
"id"
],
"title": "TaskPatchPayload",
"type": "object"
}
Fields: