Platform models

Models of the platform endpoints.

Generated by python -m codegen from the iikoCloud OpenAPI specification. Do not edit by hand.

EventAttributeDoc

Bases: IikoModel

EventAttributeDoc.

code class-attribute instance-attribute

code: str | None = None

Attribute code

value class-attribute instance-attribute

value: Any | None = None

Attribute value. The type depends on valueType: bool | string | int | float | date | guid

EventGroup

Bases: IikoModel

EventGroup.

code class-attribute instance-attribute

code: str | None = None

Event group code

event_types class-attribute instance-attribute

event_types: list[EventType] | None = None

Event types of the group

name class-attribute instance-attribute

name: str | None = None

Event group name

EventListItem

Bases: IikoModel

EventListItem.

attributes class-attribute instance-attribute

attributes: list[EventAttributeDoc] | None = None

Event attributes

event_type class-attribute instance-attribute

event_type: str | None = None

Event type code

id class-attribute instance-attribute

id: str | None = None

Event identifier (UUID), unique

occurred_at class-attribute instance-attribute

occurred_at: str | None = None

Event date and time

source class-attribute instance-attribute

source: str | None = None

Data source: RMS if organizationId is provided in the request, otherwise Chain

EventListRequest

Bases: IikoModel

EventListRequest.

event_types class-attribute instance-attribute

event_types: list[str] | None = None

Event codes to filter by. If omitted or empty, all events are returned

from_revision class-attribute instance-attribute

from_revision: int | None = None

Revision to request events from (incremental mode), must be zero or greater. Required unless both fromTime and toTime are provided. Cannot be combined with fromTime/toTime

from_time class-attribute instance-attribute

from_time: IsoDateTime | None = None

Period start, inclusive, date-time format. Required together with toTime when fromRevision is not provided

organization_id class-attribute instance-attribute

organization_id: str | None = None

Organization identifier (GUID). If provided, the request goes to the RMS API; otherwise to the Chain API by userContext.uocId

to_time class-attribute instance-attribute

to_time: IsoDateTime | None = None

Period end, exclusive, date-time format. Required together with fromTime when fromRevision is not provided

EventListResponse

Bases: IikoModel

EventListResponse.

revision class-attribute instance-attribute

revision: int | None = None

Revision up to which events are returned inclusively. Use revision + 1 for the next request

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of events in the response

EventMetadataListRequest

Bases: IikoModel

EventMetadataListRequest.

EventMetadataListResponse

Bases: IikoModel

EventMetadataListResponse.

event_groups class-attribute instance-attribute

event_groups: list[EventGroup] | None = None

Event groups

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of event groups

EventType

Bases: IikoModel

EventType.

code class-attribute instance-attribute

code: str | None = None

Event type code

name class-attribute instance-attribute

name: str | None = None

Event type name

severity class-attribute instance-attribute

severity: int | None = None

Event severity level