Substances V4
Bases: BaseAlbertModel
A lightweight substance record from a search result.
Attributes:
| Name | Type | Description |
|---|---|---|
substance_id |
str | None
|
The unique substance identifier. |
cas_id |
str | None
|
The CAS number. |
ec_list_no |
str | None
|
The EC list number. |
name |
str | None
|
The substance name. |
hazards |
list[dict] | None
|
Hazard classifications. |
wgk |
str | None
|
Water hazard class (WGK). |
classification_type |
str | None
|
The classification type (e.g. Harmonised C&L, Self Classified). |
Show JSON schema:
{
"additionalProperties": true,
"description": "A lightweight substance record from a search result.\n\nAttributes\n----------\nsubstance_id : str | None\n The unique substance identifier.\ncas_id : str | None\n The CAS number.\nec_list_no : str | None\n The EC list number.\nname : str | None\n The substance name.\nhazards : list[dict] | None\n Hazard classifications.\nwgk : str | None\n Water hazard class (WGK).\nclassification_type : str | None\n The classification type (e.g. Harmonised C&L, Self Classified).",
"properties": {
"substanceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Substanceid"
},
"casID": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Casid"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Eclistno"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"hazards": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Hazards"
},
"WGK": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Wgk"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classificationtype"
}
},
"title": "SubstanceV4SearchItem",
"type": "object"
}
Config:
extra:allow
Fields:
-
substance_id(str | None) -
cas_id(str | None) -
ec_list_no(str | None) -
name(str | None) -
hazards(list[dict] | None) -
wgk(str | None) -
classification_type(str | None)
Bases: BaseAlbertModel
A full substance record.
Attributes:
| Name | Type | Description |
|---|---|---|
substance_id |
str | None
|
The unique substance identifier. |
cas_id |
str | None
|
The CAS number. |
ec_list_no |
str | None
|
The EC list number. |
index_no |
str | None
|
The index number. |
name |
list[dict] | None
|
The substance name in one or more languages. |
hazards |
list[dict] | None
|
Hazard classifications. |
specific_concentration_limit |
list[dict] | None
|
Specific concentration limits. |
oels |
bool | None
|
Whether occupational exposure limits exist. |
exposure_controls_acgih |
list[dict] | None
|
ACGIH exposure controls. |
exposure_controls_osha |
list[dict] | None
|
OSHA exposure controls. |
exposure_controls_aiha |
list[dict] | None
|
AIHA exposure controls. |
exposure_controls_niosh |
list[dict] | None
|
NIOSH exposure controls. |
lethal_dose_and_concentrations |
list[dict] | None
|
Lethal dose and concentration data. |
inhalation_acute_toxicity |
float | None
|
Inhalation acute toxicity value. |
dermal_acute_toxicity |
float | None
|
Dermal acute toxicity value. |
oral_acute_toxicity |
float | None
|
Oral acute toxicity value. |
health_effects |
str | None
|
Health effects description. |
ntp_carcinogen |
str | None
|
NTP carcinogen classification. |
iarc_carcinogen |
str | None
|
IARC carcinogen classification. |
osha_carcinogen |
bool | None
|
OSHA carcinogen flag. |
classification_type |
str | None
|
The classification type. |
classification |
str | None
|
The classification value. |
reach_registration_no |
str | None
|
REACH registration number. |
source |
str | None
|
Data source. |
metadata |
dict[str, Any] | None
|
Tenant custom metadata. Scalar fields are plain strings or numbers.
List-type fields return a list of |
Show JSON schema:
{
"additionalProperties": true,
"description": "A full substance record.\n\nAttributes\n----------\nsubstance_id : str | None\n The unique substance identifier.\ncas_id : str | None\n The CAS number.\nec_list_no : str | None\n The EC list number.\nindex_no : str | None\n The index number.\nname : list[dict] | None\n The substance name in one or more languages.\nhazards : list[dict] | None\n Hazard classifications.\nspecific_concentration_limit : list[dict] | None\n Specific concentration limits.\noels : bool | None\n Whether occupational exposure limits exist.\nexposure_controls_acgih : list[dict] | None\n ACGIH exposure controls.\nexposure_controls_osha : list[dict] | None\n OSHA exposure controls.\nexposure_controls_aiha : list[dict] | None\n AIHA exposure controls.\nexposure_controls_niosh : list[dict] | None\n NIOSH exposure controls.\nlethal_dose_and_concentrations : list[dict] | None\n Lethal dose and concentration data.\ninhalation_acute_toxicity : float | None\n Inhalation acute toxicity value.\ndermal_acute_toxicity : float | None\n Dermal acute toxicity value.\noral_acute_toxicity : float | None\n Oral acute toxicity value.\nhealth_effects : str | None\n Health effects description.\nntp_carcinogen : str | None\n NTP carcinogen classification.\niarc_carcinogen : str | None\n IARC carcinogen classification.\nosha_carcinogen : bool | None\n OSHA carcinogen flag.\nclassification_type : str | None\n The classification type.\nclassification : str | None\n The classification value.\nreach_registration_no : str | None\n REACH registration number.\nsource : str | None\n Data source.\nmetadata : dict[str, Any] | None\n Tenant custom metadata. Scalar fields are plain strings or numbers.\n List-type fields return a list of ``MetadataItem`` objects\n with ``name`` and ``id``.",
"properties": {
"substanceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Substanceid"
},
"casID": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Casid"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Eclistno"
},
"indexNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Indexno"
},
"name": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"hazards": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Hazards"
},
"specificConcentrationLimit": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Specificconcentrationlimit"
},
"oels": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Oels"
},
"exposureControlsACGIH": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsacgih"
},
"exposureControlsOSHA": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsosha"
},
"exposureControlsAIHA": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsaiha"
},
"exposureControlsNIOSH": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsniosh"
},
"lethalDoseAndConcentrations": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Lethaldoseandconcentrations"
},
"inhalationAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Inhalationacutetoxicity"
},
"dermalAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Dermalacutetoxicity"
},
"oralAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Oralacutetoxicity"
},
"healthEffects": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Healtheffects"
},
"ntpCarcinogen": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ntpcarcinogen"
},
"iarcCarcinogen": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Iarccarcinogen"
},
"oshaCarcinogen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Oshacarcinogen"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classificationtype"
},
"classification": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classification"
},
"reachRegistrationNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reachregistrationno"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"title": "SubstanceV4Info",
"type": "object"
}
Config:
extra:allow
Fields:
-
substance_id(str | None) -
cas_id(str | None) -
ec_list_no(str | None) -
index_no(str | None) -
name(list[dict] | None) -
hazards(list[dict] | None) -
specific_concentration_limit(list[dict] | None) -
oels(bool | None) -
exposure_controls_acgih(list[dict] | None) -
exposure_controls_osha(list[dict] | None) -
exposure_controls_aiha(list[dict] | None) -
exposure_controls_niosh(list[dict] | None) -
lethal_dose_and_concentrations(list[dict] | None) -
inhalation_acute_toxicity(float | None) -
dermal_acute_toxicity(float | None) -
oral_acute_toxicity(float | None) -
health_effects(str | None) -
ntp_carcinogen(str | None) -
iarc_carcinogen(str | None) -
osha_carcinogen(bool | None) -
classification_type(str | None) -
classification(str | None) -
reach_registration_no(str | None) -
source(str | None) -
metadata(dict[str, Any] | None)
Bases: BaseAlbertModel
A collection of substances with any associated retrieval errors.
Attributes:
| Name | Type | Description |
|---|---|---|
substances |
list[SubstanceV4Info]
|
The retrieved substances. |
substance_errors |
list[dict] | None
|
Errors for any substances that could not be retrieved, if any. |
Show JSON schema:
{
"$defs": {
"SubstanceV4Info": {
"additionalProperties": true,
"description": "A full substance record.\n\nAttributes\n----------\nsubstance_id : str | None\n The unique substance identifier.\ncas_id : str | None\n The CAS number.\nec_list_no : str | None\n The EC list number.\nindex_no : str | None\n The index number.\nname : list[dict] | None\n The substance name in one or more languages.\nhazards : list[dict] | None\n Hazard classifications.\nspecific_concentration_limit : list[dict] | None\n Specific concentration limits.\noels : bool | None\n Whether occupational exposure limits exist.\nexposure_controls_acgih : list[dict] | None\n ACGIH exposure controls.\nexposure_controls_osha : list[dict] | None\n OSHA exposure controls.\nexposure_controls_aiha : list[dict] | None\n AIHA exposure controls.\nexposure_controls_niosh : list[dict] | None\n NIOSH exposure controls.\nlethal_dose_and_concentrations : list[dict] | None\n Lethal dose and concentration data.\ninhalation_acute_toxicity : float | None\n Inhalation acute toxicity value.\ndermal_acute_toxicity : float | None\n Dermal acute toxicity value.\noral_acute_toxicity : float | None\n Oral acute toxicity value.\nhealth_effects : str | None\n Health effects description.\nntp_carcinogen : str | None\n NTP carcinogen classification.\niarc_carcinogen : str | None\n IARC carcinogen classification.\nosha_carcinogen : bool | None\n OSHA carcinogen flag.\nclassification_type : str | None\n The classification type.\nclassification : str | None\n The classification value.\nreach_registration_no : str | None\n REACH registration number.\nsource : str | None\n Data source.\nmetadata : dict[str, Any] | None\n Tenant custom metadata. Scalar fields are plain strings or numbers.\n List-type fields return a list of ``MetadataItem`` objects\n with ``name`` and ``id``.",
"properties": {
"substanceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Substanceid"
},
"casID": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Casid"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Eclistno"
},
"indexNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Indexno"
},
"name": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"hazards": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Hazards"
},
"specificConcentrationLimit": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Specificconcentrationlimit"
},
"oels": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Oels"
},
"exposureControlsACGIH": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsacgih"
},
"exposureControlsOSHA": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsosha"
},
"exposureControlsAIHA": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsaiha"
},
"exposureControlsNIOSH": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsniosh"
},
"lethalDoseAndConcentrations": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Lethaldoseandconcentrations"
},
"inhalationAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Inhalationacutetoxicity"
},
"dermalAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Dermalacutetoxicity"
},
"oralAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Oralacutetoxicity"
},
"healthEffects": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Healtheffects"
},
"ntpCarcinogen": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ntpcarcinogen"
},
"iarcCarcinogen": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Iarccarcinogen"
},
"oshaCarcinogen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Oshacarcinogen"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classificationtype"
},
"classification": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classification"
},
"reachRegistrationNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reachregistrationno"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"title": "SubstanceV4Info",
"type": "object"
}
},
"description": "A collection of substances with any associated retrieval errors.\n\nAttributes\n----------\nsubstances : list[SubstanceV4Info]\n The retrieved substances.\nsubstance_errors : list[dict] | None\n Errors for any substances that could not be retrieved, if any.",
"properties": {
"substances": {
"items": {
"$ref": "#/$defs/SubstanceV4Info"
},
"title": "Substances",
"type": "array"
},
"substanceErrors": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Substanceerrors"
}
},
"required": [
"substances"
],
"title": "SubstanceV4Response",
"type": "object"
}
Fields:
-
substances(list[SubstanceV4Info]) -
substance_errors(list[dict] | None)
Bases: BaseAlbertModel
An identifier entry for creating a substance.
Attributes:
| Name | Type | Description |
|---|---|---|
attribute_name |
str
|
The identifier type. One of |
value |
str
|
The identifier value. |
Show JSON schema:
{
"description": "An identifier entry for creating a substance.\n\nAttributes\n----------\nattribute_name : str\n The identifier type. One of ``casID``, ``ecListNo``, ``ts``.\nvalue : str\n The identifier value.",
"properties": {
"attributeName": {
"enum": [
"casID",
"ecListNo",
"ts"
],
"title": "Attributename",
"type": "string"
},
"value": {
"title": "Value",
"type": "string"
}
},
"required": [
"attributeName",
"value"
],
"title": "SubstanceV4Identifier",
"type": "object"
}
Fields:
-
attribute_name(Literal['casID', 'ecListNo', 'ts']) -
value(str)
Bases: BaseAlbertModel
An attribute entry for creating a substance.
Attributes:
| Name | Type | Description |
|---|---|---|
attribute_name |
str
|
The attribute name (e.g. |
data |
Any
|
The attribute data. |
region |
str | None
|
The region the attribute applies to, if any. |
Show JSON schema:
{
"description": "An attribute entry for creating a substance.\n\nAttributes\n----------\nattribute_name : str\n The attribute name (e.g. ``hazards``, ``name``).\ndata : Any\n The attribute data.\nregion : str | None\n The region the attribute applies to, if any.",
"properties": {
"attributeName": {
"title": "Attributename",
"type": "string"
},
"data": {
"title": "Data"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Region"
}
},
"required": [
"attributeName",
"data"
],
"title": "SubstanceV4Attribute",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
Defines a new substance to create.
Attributes:
| Name | Type | Description |
|---|---|---|
identifiers |
list[SubstanceV4Identifier]
|
At least one identifier (casID, ecListNo, or ts). |
attributes |
list[SubstanceV4Attribute]
|
Attribute data to associate with the substance. |
substance_id |
str | None
|
Optional explicit substance ID. |
is_global_record |
bool
|
Whether to create as a global record. Defaults to |
category |
str | None
|
Substance category (e.g. |
notes |
str | None
|
Free-text notes for the substance. |
description |
str | None
|
A description of the substance. |
cas_smiles |
str | None
|
The SMILES string for the substance. |
inchi_key |
str | None
|
The InChI key for the substance. |
iupac_name |
str | None
|
The IUPAC name for the substance. |
cactus_status |
str | None
|
The Cactus status for the substance. |
metadata |
dict[str, MetadataItem] | None
|
Custom tenant metadata. Scalar fields take a plain string. Single-select
list fields take a bare list ID string (e.g. |
Show JSON schema:
{
"$defs": {
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
},
"SubstanceV4Attribute": {
"description": "An attribute entry for creating a substance.\n\nAttributes\n----------\nattribute_name : str\n The attribute name (e.g. ``hazards``, ``name``).\ndata : Any\n The attribute data.\nregion : str | None\n The region the attribute applies to, if any.",
"properties": {
"attributeName": {
"title": "Attributename",
"type": "string"
},
"data": {
"title": "Data"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Region"
}
},
"required": [
"attributeName",
"data"
],
"title": "SubstanceV4Attribute",
"type": "object"
},
"SubstanceV4Identifier": {
"description": "An identifier entry for creating a substance.\n\nAttributes\n----------\nattribute_name : str\n The identifier type. One of ``casID``, ``ecListNo``, ``ts``.\nvalue : str\n The identifier value.",
"properties": {
"attributeName": {
"enum": [
"casID",
"ecListNo",
"ts"
],
"title": "Attributename",
"type": "string"
},
"value": {
"title": "Value",
"type": "string"
}
},
"required": [
"attributeName",
"value"
],
"title": "SubstanceV4Identifier",
"type": "object"
}
},
"description": "Defines a new substance to create.\n\nAttributes\n----------\nidentifiers : list[SubstanceV4Identifier]\n At least one identifier (casID, ecListNo, or ts).\nattributes : list[SubstanceV4Attribute]\n Attribute data to associate with the substance.\nsubstance_id : str | None\n Optional explicit substance ID.\nis_global_record : bool\n Whether to create as a global record. Defaults to ``True``.\ncategory : str | None\n Substance category (e.g. ``User``, ``Verisk``, ``TSCA - Public``).\nnotes : str | None\n Free-text notes for the substance.\ndescription : str | None\n A description of the substance.\ncas_smiles : str | None\n The SMILES string for the substance.\ninchi_key : str | None\n The InChI key for the substance.\niupac_name : str | None\n The IUPAC name for the substance.\ncactus_status : str | None\n The Cactus status for the substance.\nmetadata : dict[str, MetadataItem] | None\n Custom tenant metadata. Scalar fields take a plain string. Single-select\n list fields take a bare list ID string (e.g. ``\"LST1253\"``). Multi-select\n List-type fields take an ``EntityLink`` or ``list[EntityLink]``.",
"properties": {
"identifiers": {
"items": {
"$ref": "#/$defs/SubstanceV4Identifier"
},
"title": "Identifiers",
"type": "array"
},
"attributes": {
"items": {
"$ref": "#/$defs/SubstanceV4Attribute"
},
"title": "Attributes",
"type": "array"
},
"substanceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Substanceid"
},
"isGlobalRecord": {
"default": true,
"title": "Isglobalrecord",
"type": "boolean"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cassmiles"
},
"inchiKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inchikey"
},
"iUpacName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Iupacname"
},
"cactusStatus": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cactusstatus"
},
"Metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"required": [
"identifiers",
"attributes"
],
"title": "SubstanceV4Create",
"type": "object"
}
Fields:
-
identifiers(list[SubstanceV4Identifier]) -
attributes(list[SubstanceV4Attribute]) -
substance_id(str | None) -
is_global_record(bool) -
category(str | None) -
notes(str | None) -
description(str | None) -
cas_smiles(str | None) -
inchi_key(str | None) -
iupac_name(str | None) -
cactus_status(str | None) -
metadata(dict[str, MetadataItem] | None)
Bases: BaseAlbertModel
Result of a substance creation request.
Attributes:
| Name | Type | Description |
|---|---|---|
created_items |
list[SubstanceV4Info]
|
Successfully created substances. |
failed_items |
list[dict]
|
Items that failed to create, with error details. |
existing_items |
list[dict]
|
Items that already existed. |
Show JSON schema:
{
"$defs": {
"SubstanceV4Info": {
"additionalProperties": true,
"description": "A full substance record.\n\nAttributes\n----------\nsubstance_id : str | None\n The unique substance identifier.\ncas_id : str | None\n The CAS number.\nec_list_no : str | None\n The EC list number.\nindex_no : str | None\n The index number.\nname : list[dict] | None\n The substance name in one or more languages.\nhazards : list[dict] | None\n Hazard classifications.\nspecific_concentration_limit : list[dict] | None\n Specific concentration limits.\noels : bool | None\n Whether occupational exposure limits exist.\nexposure_controls_acgih : list[dict] | None\n ACGIH exposure controls.\nexposure_controls_osha : list[dict] | None\n OSHA exposure controls.\nexposure_controls_aiha : list[dict] | None\n AIHA exposure controls.\nexposure_controls_niosh : list[dict] | None\n NIOSH exposure controls.\nlethal_dose_and_concentrations : list[dict] | None\n Lethal dose and concentration data.\ninhalation_acute_toxicity : float | None\n Inhalation acute toxicity value.\ndermal_acute_toxicity : float | None\n Dermal acute toxicity value.\noral_acute_toxicity : float | None\n Oral acute toxicity value.\nhealth_effects : str | None\n Health effects description.\nntp_carcinogen : str | None\n NTP carcinogen classification.\niarc_carcinogen : str | None\n IARC carcinogen classification.\nosha_carcinogen : bool | None\n OSHA carcinogen flag.\nclassification_type : str | None\n The classification type.\nclassification : str | None\n The classification value.\nreach_registration_no : str | None\n REACH registration number.\nsource : str | None\n Data source.\nmetadata : dict[str, Any] | None\n Tenant custom metadata. Scalar fields are plain strings or numbers.\n List-type fields return a list of ``MetadataItem`` objects\n with ``name`` and ``id``.",
"properties": {
"substanceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Substanceid"
},
"casID": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Casid"
},
"ecListNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Eclistno"
},
"indexNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Indexno"
},
"name": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"hazards": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Hazards"
},
"specificConcentrationLimit": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Specificconcentrationlimit"
},
"oels": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Oels"
},
"exposureControlsACGIH": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsacgih"
},
"exposureControlsOSHA": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsosha"
},
"exposureControlsAIHA": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsaiha"
},
"exposureControlsNIOSH": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Exposurecontrolsniosh"
},
"lethalDoseAndConcentrations": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Lethaldoseandconcentrations"
},
"inhalationAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Inhalationacutetoxicity"
},
"dermalAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Dermalacutetoxicity"
},
"oralAcuteToxicity": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Oralacutetoxicity"
},
"healthEffects": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Healtheffects"
},
"ntpCarcinogen": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ntpcarcinogen"
},
"iarcCarcinogen": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Iarccarcinogen"
},
"oshaCarcinogen": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Oshacarcinogen"
},
"classificationType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classificationtype"
},
"classification": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Classification"
},
"reachRegistrationNo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reachregistrationno"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"title": "SubstanceV4Info",
"type": "object"
}
},
"description": "Result of a substance creation request.\n\nAttributes\n----------\ncreated_items : list[SubstanceV4Info]\n Successfully created substances.\nfailed_items : list[dict]\n Items that failed to create, with error details.\nexisting_items : list[dict]\n Items that already existed.",
"properties": {
"createdItems": {
"items": {
"$ref": "#/$defs/SubstanceV4Info"
},
"title": "Createditems",
"type": "array"
},
"failedItems": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Faileditems",
"type": "array"
},
"existingItems": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Existingitems",
"type": "array"
}
},
"title": "SubstanceV4CreateResult",
"type": "object"
}
Fields:
Bases: BaseAlbertModel
Metadata fields that can be updated on a substance.
Attributes:
| Name | Type | Description |
|---|---|---|
notes |
str | None
|
Free-text notes for the substance. |
description |
str | None
|
A description of the substance. |
cas_smiles |
str | None
|
The SMILES string for the substance. |
inchi_key |
str | None
|
The InChI key for the substance. |
iupac_name |
str | None
|
The IUPAC name for the substance. |
cactus_status |
str | None
|
The Cactus status for the substance. |
metadata |
dict[str, MetadataItem] | None
|
Custom tenant metadata. Scalar fields take a plain string. Single-select
list fields take a bare list ID string (e.g. |
Show JSON schema:
{
"$defs": {
"EntityLink": {
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Category"
}
},
"required": [
"id"
],
"title": "EntityLink",
"type": "object"
}
},
"description": "Metadata fields that can be updated on a substance.\n\nAttributes\n----------\nnotes : str | None\n Free-text notes for the substance.\ndescription : str | None\n A description of the substance.\ncas_smiles : str | None\n The SMILES string for the substance.\ninchi_key : str | None\n The InChI key for the substance.\niupac_name : str | None\n The IUPAC name for the substance.\ncactus_status : str | None\n The Cactus status for the substance.\nmetadata : dict[str, MetadataItem] | None\n Custom tenant metadata. Scalar fields take a plain string. Single-select\n list fields take a bare list ID string (e.g. ``\"LST1253\"``). Multi-select\n list fields take a list of ``MetadataItem`` objects with ``id``\n and ``value``.",
"properties": {
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"casSmiles": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cassmiles"
},
"inchiKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Inchikey"
},
"iUpacName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Iupacname"
},
"cactusStatus": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cactusstatus"
},
"metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "number"
},
{
"type": "integer"
},
{
"type": "string"
},
{
"$ref": "#/$defs/EntityLink"
},
{
"items": {
"$ref": "#/$defs/EntityLink"
},
"type": "array"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Metadata"
}
},
"title": "SubstanceV4Metadata",
"type": "object"
}
Fields:
-
notes(str | None) -
description(str | None) -
cas_smiles(str | None) -
inchi_key(str | None) -
iupac_name(str | None) -
cactus_status(str | None) -
metadata(dict[str, MetadataItem] | None)