Skip to content

Albert Python SDK Docs

Identifiers

Identifiers

albert.resources.identifiers

Functions:

Name	Description
`ensure_block_id`
`ensure_btinsight_id`
`ensure_btdataset_id`
`ensure_btmodel_id`
`ensure_btmodel_session_id`
`ensure_inventory_id`
`ensure_search_inventory_id`
`ensure_interval_id`
`ensure_parameter_id`
`ensure_paramter_group_id`
`ensure_custom_field_id`
`ensure_entity_type_id`
`ensure_data_column_id`
`ensure_datatemplate_id`
`ensure_propertydata_id`
`ensure_task_id`
`ensure_project_id`
`ensure_project_search_id`
`ensure_link_id`
`ensure_lot_id`
`ensure_notebook_id`
`ensure_synthesis_id`
`ensure_tag_id`
`ensure_worksheet_id`
`ensure_user_id`
`ensure_unit_id`
`ensure_workflow_id`
`ensure_row_id`

Attributes:

Name	Type	Description
`BlockId`
`BTInsightId`
`BTDatasetId`
`BTModelId`
`BTModelSessionId`
`InventoryId`
`SearchInventoryId`
`IntervalId`
`ParameterId`
`ParameterGroupId`
`CustomFieldId`
`EntityTypeId`
`DataColumnId`
`DataTemplateId`
`PropertyDataId`
`TaskId`
`ProjectId`
`SearchProjectId`
`LinkId`
`LotId`
`NotebookId`
`SynthesisId`
`TagId`
`WorksheetId`
`UserId`
`UnitId`
`WorkflowId`
`RowId`

BlockId

BlockId = Annotated[str, AfterValidator(ensure_block_id)]

BTInsightId

BTInsightId = Annotated[
    str, AfterValidator(ensure_btinsight_id)
]

BTDatasetId

BTDatasetId = Annotated[
    str, AfterValidator(ensure_btdataset_id)
]

BTModelId

BTModelId = Annotated[
    str, AfterValidator(ensure_btmodel_id)
]

BTModelSessionId

BTModelSessionId = Annotated[
    str, AfterValidator(ensure_btmodel_session_id)
]

InventoryId

InventoryId = Annotated[
    str, AfterValidator(ensure_inventory_id)
]

SearchInventoryId

SearchInventoryId = Annotated[
    str, AfterValidator(ensure_search_inventory_id)
]

IntervalId

IntervalId = Annotated[
    str, AfterValidator(ensure_interval_id)
]

ParameterId

ParameterId = Annotated[
    str, AfterValidator(ensure_parameter_id)
]

ParameterGroupId

ParameterGroupId = Annotated[
    str, AfterValidator(ensure_paramter_group_id)
]

CustomFieldId

CustomFieldId = Annotated[
    str, AfterValidator(ensure_custom_field_id)
]

EntityTypeId

EntityTypeId = Annotated[
    str, AfterValidator(ensure_entity_type_id)
]

DataColumnId

DataColumnId = Annotated[
    str, AfterValidator(ensure_data_column_id)
]

DataTemplateId

DataTemplateId = Annotated[
    str, AfterValidator(ensure_datatemplate_id)
]

PropertyDataId

PropertyDataId = Annotated[
    str, AfterValidator(ensure_propertydata_id)
]

TaskId

TaskId = Annotated[str, AfterValidator(ensure_task_id)]

ProjectId

ProjectId = Annotated[
    str, AfterValidator(ensure_project_id)
]

SearchProjectId

SearchProjectId = Annotated[
    str, AfterValidator(ensure_project_search_id)
]

LinkId

LinkId = Annotated[str, AfterValidator(ensure_link_id)]

LotId

LotId = Annotated[str, AfterValidator(ensure_lot_id)]

NotebookId

NotebookId = Annotated[
    str, AfterValidator(ensure_notebook_id)
]

SynthesisId

SynthesisId = Annotated[
    str, AfterValidator(ensure_synthesis_id)
]

TagId

TagId = Annotated[str, AfterValidator(ensure_tag_id)]

WorksheetId

WorksheetId = Annotated[
    str, AfterValidator(ensure_worksheet_id)
]

UserId

UserId = Annotated[str, AfterValidator(ensure_user_id)]

UnitId

UnitId = Annotated[str, AfterValidator(ensure_unit_id)]

WorkflowId

WorkflowId = Annotated[
    str, AfterValidator(ensure_workflow_id)
]

RowId

RowId = Annotated[str, AfterValidator(ensure_row_id)]

ensure_block_id

ensure_block_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_block_id(id: str) -> str:
    return _ensure_albert_id(id, "BlockId")

ensure_btinsight_id

ensure_btinsight_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_btinsight_id(id: str) -> str:
    return _ensure_albert_id(id, "BTInsightId")

ensure_btdataset_id

ensure_btdataset_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_btdataset_id(id: str) -> str:
    return _ensure_albert_id(id, "BTDatasetId")

ensure_btmodel_id

ensure_btmodel_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_btmodel_id(id: str) -> str:
    return _ensure_albert_id(id, "BTModelId")

ensure_btmodel_session_id

ensure_btmodel_session_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_btmodel_session_id(id: str) -> str:
    return _ensure_albert_id(id, "BTModelSessionId")

ensure_inventory_id

ensure_inventory_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_inventory_id(id: str) -> str:
    id = _validate_coded_id(id, "InventoryId")
    return _ensure_albert_id(id, "InventoryId")

ensure_search_inventory_id

ensure_search_inventory_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_search_inventory_id(id: str) -> str:
    id = _validate_coded_id(id, "SearchInventoryId")
    if id.upper().startswith("INV"):
        id = id[3:]  # Remove INV prefix
    return id

ensure_interval_id

ensure_interval_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_interval_id(id: str) -> str:
    if not id:
        raise ValueError("IntervalId cannot be empty")

    # Check if it matches ROW# or ROW#XROW# pattern
    parts = id.upper().split("X")
    if len(parts) > 2:
        raise ValueError(f"IntervalId {id} is invalid. Must be in format ROW# or ROW#XROW#")

    for part in parts:
        if not part.startswith("ROW") or not part[3:].isdigit():
            raise ValueError(f"IntervalId {id} is invalid. Must be in format ROW# or ROW#XROW#")

    return id.upper()

ensure_parameter_id

ensure_parameter_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_parameter_id(id: str) -> str:
    return _ensure_albert_id(id, "ParameterId")

ensure_paramter_group_id

ensure_paramter_group_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_paramter_group_id(id: str) -> str:
    return _ensure_albert_id(id, "ParameterGroupId")

ensure_custom_field_id

ensure_custom_field_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_custom_field_id(id: str) -> str:
    return _ensure_albert_id(id, "CustomFieldId")

ensure_entity_type_id

ensure_entity_type_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_entity_type_id(id: str) -> str:
    return _ensure_albert_id(id, "EntityTypeId")

ensure_data_column_id

ensure_data_column_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_data_column_id(id: str) -> str:
    return _ensure_albert_id(id, "DataColumnId")

ensure_datatemplate_id

ensure_datatemplate_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_datatemplate_id(id: str) -> str:
    if id and id.upper().startswith("DT"):
        id = f"DAT{id[2:]}"  # Replace DT with DAT
    return _ensure_albert_id(id, "DataTemplateId")

ensure_propertydata_id

ensure_propertydata_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_propertydata_id(id: str) -> str:
    return _ensure_albert_id(id, "PropertyDataId")

ensure_task_id

ensure_task_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_task_id(id: str) -> str:
    return _ensure_albert_id(id, "TaskId")

ensure_project_id

ensure_project_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_project_id(id: str) -> str:
    return _ensure_albert_id(id, "ProjectId")

ensure_project_search_id

ensure_project_search_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_project_search_id(id: str) -> str:
    id = _validate_coded_id(id, "ProjectSearchId")
    if id.upper().startswith("PRO"):
        id = id[3:]  # Remove PRO prefix
    return id

ensure_link_id

ensure_link_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_link_id(id: str) -> str:
    return _ensure_albert_id(id, "LinkId")

ensure_lot_id

ensure_lot_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_lot_id(id: str) -> str:
    return _ensure_albert_id(id, "LotId")

ensure_notebook_id

ensure_notebook_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_notebook_id(id: str) -> str:
    return _ensure_albert_id(id, "NotebookId")

ensure_synthesis_id

ensure_synthesis_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_synthesis_id(id: str) -> str:
    return _ensure_albert_id(id, "SynthesisId")

ensure_tag_id

ensure_tag_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_tag_id(id: str) -> str:
    return _ensure_albert_id(id, "TagId")

ensure_worksheet_id

ensure_worksheet_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_worksheet_id(id: str) -> str:
    return _ensure_albert_id(id, "WorksheetId")

ensure_user_id

ensure_user_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_user_id(id: str) -> str:
    return _ensure_albert_id(id, "UserId")

ensure_unit_id

ensure_unit_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_unit_id(id: str) -> str:
    return _ensure_albert_id(id, "UnitId")

ensure_workflow_id

ensure_workflow_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_workflow_id(id: str) -> str:
    return _ensure_albert_id(id, "WorkflowId")

ensure_row_id

ensure_row_id(id: str) -> str

Source code in src/albert/resources/identifiers.py

def ensure_row_id(id: str) -> str:
    return _ensure_albert_id(id, "RowId")