1. Step6
modpanels
  • Admin
  • App
    • Compatibility
      GET
  • Auth
    • Registration
      • RegistrationStart
      • RegistrationComplete
    • PasswordReset
      • PasswordResetStart
      • PasswordResetComplete
    • OTP
      • OTPResend
      • OTPVerify
    • Login
      POST
    • AuthMe
      GET
    • Refresh
      POST
    • Logout
      POST
  • Me
    • ProfileRead
    • ProfileUpdate
    • ProfileDelete
    • PasswordChange
    • EmailChangeStart
    • PhoneChangeStart
  • Projects
    • Collection
      • ProjectCreate
      • ProjectList
      • ProjectCounts
      • ProjectQuickSearch
      • TagList
      • ProjectImport
    • Archived
      • ProjectsArchivedRestore
      • ProjectsArchivedDelete
    • Project
      • ProjectRead
      • ProjectUpdate
      • ProjectDelete
    • ProjectActions
      • ProjectFavoriteAdd
      • ProjectFavoriteDelete
      • ProjectArchive
      • ProjectRestore
      • ProjectDuplicate
      • ProjectExport
    • Configuration
      • Project
        • ProjectConfigSnapshot
      • Panel
        • PanelList
        • PanelCreate
        • PanelUpdate
        • PanelDelete
        • PanelDuplicate
        • PanelConfigSnapshot
      • Step3
        • Step2
          • ObjectParamsRead
          • ObjectParamsUpdate
          • PanelInit
          • PanelChangeClass
          • EquipmentClassCatalog
        • LoadsRead
        • LoadsUpdate
        • LoadCatalog
        • RoomCatalog
      • Step4
        • SingleLineRead
        • SingleLineUpdate
        • SingleLineGenerate
        • SingleLineAutopick
        • SingleLineValidate
        • DeviceTypeCatalog
        • DeviceFilters
        • DeviceRead
        • DeviceImportTemplate
        • DeviceImport
      • Step5
        • PanelParamsRead
        • PanelParamsUpdate
        • PanelParamsValidate
      • Step6
        • VisualizationRead
          GET
        • VisualizationUpdate
          PUT
        • VisualizationValidate
          POST
        • VisualizationDistribute
          POST
        • PanelFilters
          POST
        • PanelRead
          GET
        • CustomPanel
          GET
        • VisualDeviceRead
          GET
        • VisualizationImport
          POST
      • Step7
        • AccessoriesList
        • BucketRead
        • UpdateBucket
      • Step8
        • DownloadDocumentationArchive
        • GetDocumentationExportStatus
        • CreateDocumentationExport
  • Favorites
    • FavoriteList
    • FavoriteDelete
    • FavoritesAdd
    • FavoritesUnfavorite
  • Public
    • PublicProject
    • PublicProjectExport
  • Legal
    • PrivacyPolicy
    • TermsOfService
  • Admin
    • admin-users
      • ListAdminUsers
      • CreateAdminUser
      • DeleteAdminUsers
      • GetAdminUser
      • UpdateAdminUser
      • DeleteAdminUser
      • SetAdminUsersRole
    • admin-analytics
      • ExportAdminAnalytics
    • admin-equipment
      • DownloadEquipmentCatalog
      • UploadEquipmentCatalog
      • ListEquipmentDrawings
      • DeleteEquipmentDrawings
      • DownloadEquipmentDrawings
      • UploadApparatusDrawing
      • UploadShieldDrawings
      • GetEquipmentDrawing
      • DownloadEquipmentDrawingFile
  • CityList
    GET
  • Liveness
    GET
  • Schemas
    • Auth
      • Context
        • PublicOtpVerifyRequest
        • PublicOtpResendRequest
        • AuthorizedOtpVerifyRequest
        • AuthorizedOtpResendRequest
        • ContextVerifyRequest
        • ContextTokenResponse
        • ContextTokenRequest
      • Registration
        • RegisterCompleteRequest
      • Password
        • PasswordResetConfirmRequest
        • PasswordChangeRequest
      • EmailOrPhone
      • LoginRequest
      • RefreshRequest
      • AuthTokensResponse
      • AuthMe
      • LogoutRequest
    • Profile
      • ProfileRead
      • ProfileUpdate
      • EmailChangeRequest
      • PhoneChangeRequest
    • Cities
      • CityItem
      • CityCatalog
    • Projects
      • ProjectCreateRequest
      • ProjectResponse
      • ProjectUpdateRequest
      • ProjectListItem
      • ProjectListResponse
      • ProjectCounts
      • TagList
      • ProjectQuickSearchResponse
    • Configuration
      • Project
        • ConfigLimits
        • ConfigLimitUsage
        • ConfigState
        • ConfigProjectInfo
        • ProjectConfigSnapshot
      • Panel
        • PanelsList
        • PanelListItem
        • PanelCreate
        • PanelUpdate
        • PanelState
        • StepState
        • PanelConfigSnapshot
        • Reactivity
        • EquipmentClass
        • PremiseType
        • SupplyNetwork
      • Step2
        • PanelSizeConstraints
        • ObjectParams
        • ObjectParamsResponse
        • ObjectParamsUpdate
        • ObjectParamsUpdateResponse
        • PanelChangeClass
        • EquipmentClassItem
        • EquipmentClassCatalog
        • ReservePercent
        • ChangeClassResponse
      • Step3
        • Room
        • LoadItemCustom
        • LoadItemPreset
        • Loads
        • LoadsResponse
        • RoomUpdate
        • LoadItemCustomUpdate
        • LoadItemPresetUpdate
        • LoadsUpdate
        • LoadsUpdateResponse
        • LoadCatalogItem
        • LoadCatalog
        • RoomCatalogItem
        • RoomCatalog
        • RoomType
      • Step4
        • Consumer
        • Wires
        • DeviceType
        • DeviceBlackboxType
        • AccessoryType
        • DevicePart
        • Device
        • DeviceBlackbox
        • Row
        • SingleLine
        • SingleLineResponse
        • DevicePartUpdate
        • DeviceUpdate
        • DeviceBlackboxUpdate
        • RowUpdate
        • SingleLineUpdate
        • SingleLineUpdateResponse
        • SingleLineGenerateRequest
        • SingleLineGenerateResponse
        • SingleLineAutopickRequest
        • SingleLineAutopickResponse
        • RowValidate
        • SingleLineValidate
        • RowValidationError
        • SingleLineValidateResponse
        • DeviceTypeItem
        • DeviceTypeCatalog
        • DeviceFiltersRequest
        • DeviceFiltersResponse
      • Step5
        • CrossModule
        • CustomPanel
        • PanelParams
        • PanelParamsResponse
        • CustomPanelUpdate
        • PanelParamsUpdate
        • PanelParamsUpdateResponse
      • Step6
        • EnclosureMccbParams
        • EnclosureParams
        • EnclosureImages
        • CatalogEnclosure
        • CustomEnclosure
        • VisualizationWiring
        • VisualizationDrawing
        • VisualizationPlacement
        • VisualizationDevicePart
        • HubDevice
        • HubBlackbox
        • InstalledDevice
        • InstalledBlackbox
        • VisualizationCrossModule
        • Visualization
        • VisualizationResponse
        • CatalogEnclosureUpdate
        • CustomEnclosureUpdate
        • HubDeviceUpdate
        • HubBlackboxUpdate
        • InstalledDeviceUpdate
        • InstalledBlackboxUpdate
        • VisualizationCrossModuleUpdate
        • VisualizationUpdate
        • VisualizationUpdateResponse
        • VisualizationValidationError
        • VisualizationValidateResponse
        • PanelFiltersRequest
        • PanelFiltersResponse
      • Step7
        • AccessoryItem
        • AccessoryListRequest
        • AccessoryListResponse
        • BucketItemUpdate
        • BucketItem
        • BucketResponse
        • BucketUpdateResponse
      • Step8
        • DocumentationExportRequest
        • DocumentationDocument
        • DocumentationExportTask
        • DocumentationArchive
        • DocumentationDocumentFull
        • DocumentationDocumentSpecification
        • DocumentationDocumentAppearance
        • DocumentationDocumentSingleLine
        • DocumentationDocumentStickers
    • Favorites
      • FavoriteCatalogDevice
      • FavoriteBlackboxDevice
      • FavoriteCatalogPanel
      • FavoriteCustomPanel
      • FavoriteCreate
      • FavoriteCatalogItem
      • FavoriteBlackboxItem
      • FavoriteListRequest
      • FavoriteListResponse
    • Shared
      • Filters
      • FilterField
      • FilterFields
      • ValueField
      • AvailableValues
      • ArticleImage
      • ValidationError
      • StatusOk
      • IdName
      • SortOrder
    • Admin
      • AdminAssignableRole
      • AdminUsersSortField
      • AdminUser
      • AdminUsersList
      • AdminUserCreateRequest
      • AdminUserUpdateRequest
      • AdminUsersIdsRequest
      • AdminUsersSetRoleRequest
      • AdminAnalyticsPeriod
      • AdminAnalyticsFormat
      • AdminAnalyticsExportField
      • AdminAnalyticsExportRequest
      • EquipmentCatalogInfo
      • EquipmentDrawingType
      • EquipmentDrawingsSortField
      • EquipmentDrawing
      • EquipmentDrawingsList
      • EquipmentDrawingsIdsRequest
      • UploadApparatusDrawingRequest
      • UploadShieldDrawingsRequest
      • EquipmentDrawingsUploadResult
    • ApiError
    • CompatibilityResponse
  1. Step6

VisualizationRead

Developing
GET
/projects/{projectId}/panels/{panelId}/visualization

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Responses

🟢200Success
application/json
Bodyapplication/json

🟠422UnprocessableContent
🟠401Unauthorized
🟠403Forbidden
🟠426ClientUnsupported
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/projects//panels//visualization' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "revision": 0,
    "data": {
        "enclosure": {
            "type": "catalog",
            "article": "string",
            "name": "string",
            "isFavorite": true,
            "weightKg": 0,
            "visualParams": {
                "railCount": 0,
                "modulesPerRail": 0,
                "rails": [
                    {
                        "originX": 0,
                        "centerY": 0
                    }
                ],
                "widthMm": 0,
                "heightMm": 0,
                "depthMm": 0,
                "doorDx": 0,
                "doorDy": 0,
                "frontalPlateDx": 0,
                "frontalPlateDy": 0
            },
            "mccb": {
                "deviceCenterX": 0,
                "deviceCenterY": 0,
                "montagePlate": "string",
                "montagePlateDx": 0,
                "montagePlateDy": 0,
                "rearBars": "string",
                "rearBarsCenterX": 0,
                "rearBarsCenterY": 0,
                "frontalPlate": "string",
                "labelY": 0
            },
            "images": {
                "frame": "http://example.com",
                "frontalPlate": "http://example.com",
                "door": "http://example.com"
            },
            "params": {}
        },
        "hub": [
            {
                "type": "av",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "article": "string",
                "name": "string",
                "designation": "string",
                "class": "basic",
                "isFavorite": true,
                "selectorCode": "string",
                "imageUrl": "http://example.com",
                "params": {},
                "widthInModules": 0,
                "weightKg": 0,
                "isIncomer": true,
                "isMccb": true,
                "wiring": {
                    "topConnectionIds": [
                        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                    ],
                    "bottomConnectionIds": [
                        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                    ]
                },
                "drawing": {
                    "visualUrl": "string",
                    "width": 0,
                    "height": 0,
                    "dx": 0,
                    "dy": 0
                },
                "parts": [
                    {
                        "type": "string",
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "article": "string",
                        "name": "string",
                        "widthInModules": 0,
                        "weightKg": 0,
                        "imageUrl": "http://example.com",
                        "drawing": {
                            "visualUrl": "string",
                            "width": 0,
                            "height": 0,
                            "dx": 0,
                            "dy": 0
                        }
                    }
                ]
            }
        ],
        "installed": [
            {
                "type": "av",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "article": "string",
                "name": "string",
                "designation": "string",
                "class": "basic",
                "isFavorite": true,
                "selectorCode": "string",
                "imageUrl": "http://example.com",
                "params": {},
                "widthInModules": 0,
                "weightKg": 0,
                "isIncomer": true,
                "isMccb": true,
                "wiring": {
                    "topConnectionIds": [
                        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                    ],
                    "bottomConnectionIds": [
                        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                    ]
                },
                "placement": {
                    "railPosition": 0,
                    "modulePosition": 0
                },
                "drawing": {
                    "visualUrl": "string",
                    "width": 0,
                    "height": 0,
                    "dx": 0,
                    "dy": 0
                },
                "parts": [
                    {
                        "type": "string",
                        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                        "article": "string",
                        "name": "string",
                        "widthInModules": 0,
                        "weightKg": 0,
                        "imageUrl": "http://example.com",
                        "drawing": {
                            "visualUrl": "string",
                            "width": 0,
                            "height": 0,
                            "dx": 0,
                            "dy": 0
                        }
                    }
                ]
            }
        ],
        "crossModules": [
            {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "article": "string",
                "name": "string",
                "designation": "string",
                "imageUrl": "http://example.com",
                "params": {},
                "widthInModules": 0,
                "weightKg": 0,
                "placement": {
                    "railPosition": 0,
                    "modulePosition": 0
                },
                "drawing": {
                    "visualUrl": "string",
                    "width": 0,
                    "height": 0,
                    "dx": 0,
                    "dy": 0
                }
            }
        ],
        "reservePercent": 30,
        "sizeConstraints": {
            "maxWidthMm": null,
            "maxHeightMm": null,
            "maxDepthMm": null
        },
        "mainIncomerId": "6e871ce7-5fb1-4d78-a4b0-bd560290c456"
    }
}
Modified at 2026-08-19 11:29:06
Previous
PanelParamsValidate
Next
VisualizationUpdate
Built with