PageDataWidgetTypeInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/viridi-parente/main/json-schema/viridi-parente-page-data-widget-type-info-schema.json",
  "title": "PageDataWidgetTypeInfo",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/viridi-parente-widget-type-controller-api-openapi.yml#/components/schemas/PageDataWidgetTypeInfo",
  "properties": {
    "data": {
      "type": "array",
      "description": "Array of the entities",
      "items": {
        "$ref": "#/$defs/WidgetTypeInfo"
      },
      "readOnly": true
    },
    "totalPages": {
      "type": "integer",
      "format": "int32",
      "description": "Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria",
      "readOnly": true
    },
    "totalElements": {
      "type": "integer",
      "format": "int64",
      "description": "Total number of elements in all available pages",
      "readOnly": true
    },
    "hasNext": {
      "type": "boolean",
      "description": "'false' value indicates the end of the result set",
      "readOnly": true
    }
  },
  "$defs": {
    "TenantId": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the entity, time-based UUID v1"
        },
        "entityType": {
          "type": "string",
          "description": "string",
          "enum": [
            "TENANT"
          ]
        }
      },
      "required": [
        "entityType",
        "id"
      ]
    },
    "WidgetTypeId": {
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "ID of the entity, time-based UUID v1"
        },
        "entityType": {
          "type": "string",
          "description": "string",
          "enum": [
            "WIDGET_TYPE"
          ]
        }
      },
      "required": [
        "entityType",
        "id"
      ]
    },
    "WidgetTypeInfo": {
      "properties": {
        "id": {
          "$ref": "#/$defs/WidgetTypeId",
          "description": "JSON object with the Widget Type Id. Specify this field to update the Widget Type. Referencing non-existing Widget Type Id will cause error. Omit this field to create new Widget Type."
        },
        "createdTime": {
          "type": "integer",
          "format": "int64",
          "description": "Timestamp of the Widget Type creation, in milliseconds",
          "readOnly": true
        },
        "tenantId": {
          "$ref": "#/$defs/TenantId",
          "description": "JSON object with Tenant Id.",
          "readOnly": true
        },
        "fqn": {
          "type": "string",
          "description": "Unique FQN that is used in dashboards as a reference widget type",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Widget name used in search and UI",
          "readOnly": true
        },
        "deprecated": {
          "type": "boolean",
          "description": "Whether widget type is deprecated."
        },
        "image": {
          "type": "string",
          "description": "Base64 encoded widget thumbnail",
          "readOnly": true
        },
        "description": {
          "type": "string",
          "description": "Description of the widget type",
          "readOnly": true
        },
        "tags": {
          "type": "array",
          "description": "Tags of the widget type",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "widgetType": {
          "type": "string",
          "description": "Type of the widget (timeseries, latest, control, alarm or static)",
          "readOnly": true
        }
      }
    }
  }
}