Object models

Pydantic models for request and response bodies. Fields use snake_case in Python; the API's PascalCase names are kept as aliases.

Assets

Asset pydantic-model

Bases: BaseAtonixModel

Atonix Asset definition.

Fields:

• id (str)
• abbrev (str)
• desc (str)
• parent_id (str | None)
• asset_type_name (str)
• create_date (datetime)
• change_date (datetime)

Issues

BareIssue pydantic-model

Bases: BaseAtonixModel

Bare reference to an issue.

Fields:

• id (str)
• title (str)

Issue pydantic-model

Bases: BaseAtonixModel

Full issue details.

Fields:

• id (str)
• asset_id (str)
• title (str)
• short_summary (str | None)
• full_summary (str | None)
• category_desc (str | None)
• category_id (int | None)
• changed_by (str | None)
• change_date (datetime)
• close_date (datetime | None)
• created_by (str | None)
• create_date (datetime)
• impact (float | None)
• issue_class_type_desc (str | None)
• issue_status (str)
• issue_type_desc (str | None)
• issue_cause_type_descs (list[str])
• links (IssueLinks | None)
• numeric_id (int | None)
• priority (str | None)
• resolution_status (str | None)
• resolve_by_date (datetime | None)
• scorecard (bool | None)

IssueCreate pydantic-model

Bases: BaseAtonixModel

Properties for creating new issue.

Fields:

• asset_id (str)
• title (str)
• category_desc (str)
• issue_class_type_desc (str)
• created_by (str | None)
• full_summary (str | None)
• priority (str | None)
• resolution_status (str | None)
• resolve_by_date (datetime | None)
• scorecard (bool | None)
• short_summary (str | None)

IssuePatch pydantic-model

Bases: BaseAtonixModel

Properties that are allowed to be patched.

Fields:

• title (str | None)
• short_summary (str | None)
• full_summary (str | None)
• priority (str | None)
• resolve_by_date (datetime | None)
• scorecard (bool | None)
• resolution_status (str | None)
• changed_by (str | None)
• status (str | None)
• issue_type_desc (str | None)

IssueKeyword pydantic-model

Bases: BaseAtonixModel

Keyword providing insight to the issue.

Fields:

• keyword_desc (str)
• created_by (str | None)
• create_date (datetime | None)

Attachment pydantic-model

Bases: BaseAtonixModel

Attachment metadata.

Fields:

• filename (str)
• temporary_link (str)
• link_expiration_date (datetime)
• change_date (datetime | None)

IssueDiscussionEntryDetails pydantic-model

Bases: BaseAtonixModel

Discussion Entry with attachments.

Fields:

• title (str)
• contents (str)
• created_by (str)
• create_date (datetime)
• changed_by (str | None)
• change_date (datetime | None)
• attachments (list[Attachment])

IssueDiscussionEntryCreate pydantic-model

Bases: BaseAtonixModel

Properties for creating new discussion entry.

Fields:

• title (str)
• contents (str)
• created_by (str | None)
• attachment_files (list[str])

IssueResolutionStatus pydantic-model

Bases: BaseAtonixModel

Resolution status type.

Fields:

• resolution_status (str)
• display_order (int)

Models

AlertState pydantic-model

Bases: BaseAtonixModel

Current alert state for a model. Represents the 'State' use case.

Fields:

• active (bool)
• active_alerts (list[str])
• evaluation_time (datetime)
• actual (float | None)
• expected (float | None)
• lower (float | None)
• upper (float | None)
• diagnose (bool)
• issue (bool)
• model_maintenance (bool)
• watch (bool)
• asset_id (str | None)
• model_id (str | None)

Action pydantic-model

Bases: BaseAtonixModel

Action taken on a model. Represents the 'Actions' use case.

Fields:

• action_note (str)
• action_type (str)
• change_date (datetime)
• changed_by (str)
• actual (float | None)
• expected (float | None)
• lower (float | None)
• upper (float | None)
• is_favorite (bool)
• asset_id (str | None)
• model_id (str | None)

ModelConfiguration pydantic-model

Bases: BaseAtonixModel

Full model configuration. Represents the 'Config' use case.

Fields:

• active (bool)
• model_name (str)
• model_type (str)
• tag (Tag | None)
• last_build_time (datetime | None)
• last_save_time (datetime | None)
• method_types (list[ModelPredictiveMethod])
• training_data (TrainingData | None)
• inputs (list[ModelInput])
• op_mode_types (list[str])
• anomaly_criteria (AnomalyCriteria | None)
• forecast (dict | None)
• rate_of_change (dict | None)
• moving_average_factors (dict | None)

Validators:

• normalize_null_lists
• restructure_tag

normalize_null_lists pydantic-validator

normalize_null_lists(data: Any) -> Any

Convert null values to empty lists for list fields.

The API sometimes returns null instead of empty arrays for list fields, which causes Pydantic validation errors. This validator ensures those fields are always lists.

ExternalModelConfiguration pydantic-model

Bases: BaseAtonixModel

Configuration for an external model.

Fields:

• active (bool)
• model_name (str)
• model_type (str)
• asset_id (str)
• diagnostic_drilldown_url (str | None)
• model_configuration_url (str | None)
• anomaly_criteria (AnomalyCriteria | None)

Model pydantic-model

Bases: BaseAtonixModel

Top-level Model object.

Serves as the central point for: 1. Identification (ModelId, AssetId, Name) 2. Configuration (Config) 3. State (AlertState) 4. History (Actions)

Fields:

• model_id (str)
• name (str | None)
• asset_id (str | None)
• model_type_name (str | None)
• status (str | None)
• alert_state (AlertState | None)
• config (ModelConfiguration | ExternalModelConfiguration | None)
• actions (list[Action] | None)

Process data

Server pydantic-model

Bases: BaseAtonixModel

Process Data Server.

Fields:

• server_id (str)
• name (str)
• asset_id (str)

Archive pydantic-model

Bases: BaseAtonixModel

Process Data Archive.

Fields:

• name (str)
• interval (int)

Tag pydantic-model

Bases: BaseAtonixModel

Tag Definition.

Fields:

• tag_id (str | None)
• name (str | None)
• description (str | None)
• eng_unit (str | None)
• source (str | None)
• qualifier (str | None)
• create_date (datetime | None)
• change_date (datetime | None)

TagData pydantic-model

Bases: BaseAtonixModel

Internal model for parsing Atonix query responses. Wraps the series with status info.

Fields:

• tag_id (str)
• http_code (int | None)
• error (str | None)
• timestamps (list[datetime] | None)
• values (list[float] | None)
• statuses (list[int] | None)

Common

BaseAtonixModel pydantic-model

Bases: BaseModel

Base model with common configuration.

Config:

• populate_by_name: True

update_from

update_from(other: BaseAtonixModel) -> None

Update fields from another instance of the same model.

APIResponse pydantic-model

Bases: BaseAtonixModel, Generic[T]

Standard Atonix API Response wrapper.

Fields:

• success (bool)
• status_code (int)
• count (int | None)
• type_name (str | None)
• results (list[T])