> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Post Web Panel Entity
> Create a new WebPanelEntity list item
Calls the List agent service SaveWebPanelEntity.
## OpenAPI
````yaml /openapi/rest/openapi-v3-List.json post /api/v1/List/WebPanel/Items
openapi: 3.0.0
info:
version: v1-REST
title: SuperOffice REST API v1
description: SuperOffice REST API - List
contact:
name: SuperOffice DevNet
url: https://docs.superoffice.com/en/api/index.html
email: sdk@superoffice.com
servers:
- url: http://localhost:56350
- url: https://localhost:56350
security: []
tags: []
externalDocs:
description: >-
The SuperOffice DevNet Community has more documentation, examples, and
discussion forums.
url: https://community.superoffice.com/en/developer/
paths:
/api/v1/List/WebPanel/Items:
post:
tags:
- List_WebPanel
summary: Post Web Panel Entity
description: |-
Create a new WebPanelEntity list item
Calls the List agent service SaveWebPanelEntity.
operationId: v1WebPanelEntityList_PostWebPanelEntity
parameters:
- name: Accept-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
required: false
schema:
type: string
- name: SO-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
required: false
schema:
type: string
- name: SO-Culture
in: header
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
required: false
schema:
type: string
- name: SO-TimeZone
in: header
description: >-
Specify the timezone code that you would like date/time responses
converted to.
required: false
schema:
type: string
- name: SO-AppToken
in: header
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
text/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
text/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/json-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/merge-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
description: The WebPanelEntity to be created.
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
text/json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
text/xml:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/json-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
application/merge-patch+json:
schema:
$ref: '#/components/schemas/SuperOffice.CRM.Services.WebPanelEntity'
security:
- SuperOffice_Password: []
SuperId_Authentication: []
components:
schemas:
SuperOffice.CRM.Services.WebPanelEntity:
description: "The web panel entity contains information on a web panel\r\n\r\nCarrier object for WebPanelEntity.\r\nServices for the WebPanelEntity Carrier is available from the List Agent."
type: object
properties:
WebPanelId:
format: int32
description: The identity of the web panel
type: integer
Name:
description: The name of the web panel
type: string
Tooltip:
description: The tooltip of the web panel
type: string
Deleted:
description: True if the web panel is marked as deleted
type: boolean
Rank:
format: int32
description: The rank of the web panel
type: integer
UrlEncoding:
description: The encoding of the URL
enum:
- Unknown
- None
- ANSI
- Unicode
type: string
VisibleIn:
description: The webpanel is visible in
enum:
- Invisible
- ToolboxMenu
- NavigatorButton
- ViewMenu
- SelectionTaskCard
- ContactCard
- ContactArchive
- ProjectCard
- ProjectArchive
- SaleCard
- PersonCard
- ActivityDialog
- DocumentDialog
- BrowserPanel
- ContSelectionTask
- AppntSelectionTask
- SaleSelectionTask
- DocSelectionTask
- ProjSelectionTask
- CompanyMinicard
- ProjectMinicard
- DiaryMinicard
- SelectionMinicard
- ButtonPanelTask
- AppointmentDialogTask
- SaleDialogTask
- DocumentDialogTask
- PersonDialogTask
- SaleMinicard
- SaleArchive
- AppntSelectionShadowTask
- SaleSelectionShadowTask
- DocSelectionShadowTask
- ProjSelectionShadowTask
- DiaryArchive
- SelectionContactArchive
- SelectionProjectArchive
- SelectionSaleArchive
- SelectionAppointmentArchive
- SelectionDocumentArchive
- ContSelectionCustomTask
- AppntSelectionCustomTask
- SaleSelectionCustomTask
- DocSelectionCustomTask
- ProjSelectionCustomTask
- CustomArchiveMiniCard
- SelectionCard
- ReportMinicard
- QuoteDialog
- QuoteDialogTask
- QuoteDialogArchive
- QuoteLineDialogTask
- QuoteLineDialog
- QuoteLineSelectionMainTask
- QuoteLineSelectionShadowTask
- SelectionQuoteLineArchive
- QuoteLineSelectionCustomTask
- FindSystem
- MailingSelectionTask
- ContactSelectionMailingsTask
- AppointmentSelectionMailingsTask
- SaleSelectionMailingsTask
- DocumentSelectionMailingsTask
- ProjectSelectionMailingsTask
- QuoteLineSelectionMailingsTask
- TopPanelNewMenu
- Dashboard
- PersonArchive
- PersonMinicard
- CompanyCardTask
- ProjectCardTask
- TicketCard
- TicketMinicard
- CustomObjectCard
- CustomObjectArchive
type: string
OnCentral:
description: Is the webpanel visible when user is on central database
type: boolean
OnSatellite:
description: Is the webpanel visible when user is on a satellite
type: boolean
OnTravel:
description: Is the webpanel visible when user is on travel
type: boolean
OnSalesMarketingWeb:
description: Is the webpanel visible when user is on web client
type: boolean
OnSalesMarketingPocket:
description: Is the webpanel visible when user is on pocket client
type: boolean
ShowInMenuBar:
description: Does the webpanel have a menu bar
type: boolean
ShowInToolBar:
description: Does the webpanel have a toolbar
type: boolean
ShowInAddressBar:
description: Does the webpanel have an address bar
type: boolean
ShowInStatusBar:
description: Does the webpanel have a status bar
type: boolean
WindowName:
description: The window which the URL address is to open in (webpanel only)
type: string
Url:
description: The url
type: string
ProgId:
description: >-
String key that can be used to uniquely retrieve the panel;
particularly useful for partners and others who do not wish to store
database ID's
type: string
Icon:
format: int32
description: The icon of the webpanel
type: integer
AlwaysReloadOnShow:
description: >-
If set to true, the content will reload every time the panel is
shown
type: boolean
NeverReloadOnCurrentChange:
description: >-
If set to true, the content will not reload on current changes, only
applies to sidepanels
type: boolean
CustomObjectEntity:
description: The name of the custom object when VisibleIn is set to custom object
type: string
TableRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
FieldProperties:
description: >-
Field property dictionary mapping field names to field access
rights.
type: object
additionalProperties:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
SuperOffice.CRM.Security.TableRight:
description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
type: object
properties:
Mask:
type: string
Reason:
type: string
SuperOffice.CRM.Security.FieldProperty:
description: >-
Class holding properties like field length, field type about a field in
the carrier.
type: object
properties:
FieldRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
FieldType:
type: string
FieldLength:
format: int32
description: ''
type: integer
SuperOffice.CRM.Security.FieldRight:
description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
type: object
properties:
Mask:
type: string
Reason:
type: string
````
## Related topics
- [Post Web Panel Entity Heading](/en/api/reference/restful/rest/list_webpanel/post-web-panel-entity-heading.md)
- [Put Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/put-web-panel-entity.md)
- [NSWebPanelEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSWebPanelEntity.md)
- [Get Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/get-web-panel-entity.md)
- [Delete Web Panel Entity](/en/api/reference/restful/rest/list_webpanel/delete-web-panel-entity.md)
- [Save Web Panel Entity](/en/api/reference/restful/agent/list_agent/save-web-panel-entity.md)