Platform¶

Endpoints of the Platform section of the iikoCloud API documentation.

Platform.Events¶

iiko.platform.events.list() `async` ¶

list(
    *,
    event_types: Sequence[str] | None = None,
    from_revision: int | None = None,
    from_time: datetime | str | None = None,
    organization_id: str | None = None,
    to_time: datetime | str | None = None,
    timeout: float | None = None,
) -> EventListResponse

List of events.

POST /api/platform/v1/events/list

Returns a list of events for a period or starting from a given revision. Exactly one mode is required: fromRevision, or both fromTime and toTime. fromRevision cannot be combined with fromTime or toTime.

Parameters:

Name	Type	Description	Default
`event_types`	`Sequence[str] \| None`	Event codes to filter by. If omitted or empty, all events are returned	`None`
`from_revision`	`int \| 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	`None`
`from_time`	`datetime \| str \| None`	Period start, inclusive, date-time format. Required together with toTime when fromRevision is not provided	`None`
`organization_id`	`str \| None`	Organization identifier (GUID). If provided, the request goes to the RMS API; otherwise to the Chain API by userContext.uocId	`None`
`to_time`	`datetime \| str \| None`	Period end, exclusive, date-time format. Required together with fromTime when fromRevision is not provided	`None`
`timeout`	`float \| None`	Server-side timeout in seconds (`Timeout` header). Defaults to the client setting.	`None`

Returns:

Type	Description
`EventListResponse`	The `EventListResponse` response.

iikoCloud API reference

iiko.platform.events.metadata.list() `async` ¶

list(
    *, timeout: float | None = None
) -> EventMetadataListResponse

Event groups and types.

POST /api/platform/v1/events/metadata/list

Returns a list of event groups and types