ControlledTermValue

class pyinaturalist.models.ControlledTermValue(id=None, blocking=None, label=None, ontology_uri=None, uri=None, uuid=None, taxon_ids=NOTHING)

Bases: pyinaturalist.models.base.BaseModel

A controlled term value, based on the schema of GET /controlled_terms.

Attributes

Name	Type	Description
id	int	Unique record ID
blocking	bool
label	str
ontology_uri	str
uri	str
uuid	str
taxon_ids	List[int]

Methods

__init__(id=None, blocking=None, label=None, ontology_uri=None, uri=None, uuid=None, taxon_ids=NOTHING)

Method generated by attrs for class ControlledTermValue.

classmethod from_json(value, **kwargs)

Initialize a single model object from an API response or response result.

Omits any invalid fields and None values, so default factories are used instead (e.g. for empty dicts and lists).

Return type

TypeVar(T, bound= BaseModel)

classmethod from_json_file(value)

Initialize a collection of model objects from a JSON string, file path, or file-like object

Return type

List[TypeVar(T, bound= BaseModel)]

classmethod from_json_list(value)

Initialize a collection of model objects from an API response or response results

Return type

List[TypeVar(T, bound= BaseModel)]

to_json()

Convert this object back to JSON (dict) format

Return type

Dict[str, Any]