iRetail PRO
Русский Get a key
Menu

iRetail PRO hub 1.0.0-m5: dashboards

4 operations

← All documentation · Source: contracts openapi/hub-v1.yaml at 8000474.

Pages of tiles over the analytics (spec/DASHBOARDS.md).

← iRetail PRO hub 1.0.0-m5

Operations

GET /v1/dashboards The organization's dashboards and the ready-made set (spec/DASHBOARDS.md).

operationId listDashboards · Permission report.read

Parameters

Name In Type Description
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).

Responses

GET /v1/dashboards/{id} One dashboard.

operationId getDashboard · Permission report.read

Parameters

Name In Type Description
id required path string
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).

Responses

PUT /v1/dashboards/{id} Save a dashboard; under a ready-made id, the organization's copy takes its place.

operationId putDashboard · Permission dashboard.manage

Parameters

Name In Type Description
id required path string
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).
If-Match header string The version the change is based on.

Request body required

Responses

DELETE /v1/dashboards/{id} Delete the organization's dashboard (a ready-made one comes back in its place).

operationId deleteDashboard · Permission dashboard.manage

Parameters

Name In Type Description
id required path string
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).

Responses

  • 204 Deleted
  • 401 Error (spec/API.md). Error
  • 403 Error (spec/API.md). Error
  • 404 Error (spec/API.md). Error
  • 409 Error (spec/API.md). Error

Schemas

DashboardSummary object

id required string
title required LocalizedText
description LocalizedText
source required DashboardSource
version required integer (int64) 0 for a ready-made dashboard as shipped.

DashboardSource "ready_made" | "organization"

ready_made · organization

DashboardList object

items required array of DashboardSummary

StoredDashboard object

dashboard required dashboard.schema.json
source required DashboardSource
version required integer (int64)