Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In
GitHubNuGetDev CommunityDoc feedback


**HTTP Verb** – GET

**URL** – /api/v1/dashboardpanels

**Description** – Gets the dashboard panels and data that populate the dashboard page.

**Base** – HandlerBase\<GetDashboardPanelCollectionParameter, GetDashboardPanelCollectionResult>

**Handlers**

<table class="TableStyle-Borders" style="margin-left: 0; margin-right: auto; width: 100%;" data-cellspacing="0"> <thead> <tr class="header TableStyle-Borders-Head-Header1"> <th class="TableStyle-Borders-HeadE-Regular-Header1">Order</th> <th class="TableStyle-Borders-HeadE-Regular-Header1">Handler</th> <th class="TableStyle-Borders-HeadD-Regular-Header1">Description</th> </tr> </thead> <tbody> <tr class="odd TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyE-Regular-Row1">500</td> <td class="TableStyle-Borders-BodyE-Regular-Row1">GetDashboardPanelCollection</td> <td class="TableStyle-Borders-BodyD-Regular-Row1"><p>Retrieves child pages for MyAccountPage, if MyAccountPage variant exists and DisplayLink is set to true. Child pages are filtered by ExcludeFromNavigation (pages with false value are filtered out from result).</p> <p>Examples:</p> <ul> <li>AccountSettingsPage</li> <li>MyAccountAddressPage</li> <li>SavedOrderListPage</li> <li>OrdersPage</li> <li>RfqMyQuotesPage</li> <li>WishListPage</li> </ul></td> </tr> <tr class="even TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyE-Regular-Row1">600</td> <td class="TableStyle-Borders-BodyE-Regular-Row1">SetUpDashboardPanelCollection</td> <td class="TableStyle-Borders-BodyD-Regular-Row1"><p>For current user DashboardPanelPosition records are loaded and ordered by SortOrder property. Those records are used for sorting panels; if any exists, first one will be used, otherwise constant value from DashboardPanelSortOrder will be used.</p> <p>Panel examples:</p> <ul> <li>OrderApprovalListPage</li> <li>RequisitionPage</li> <li>RfqMyQuotesPage</li> </ul> <p>For all panels IsPanel flag is set to true and depending on type Count property is set using services.</p></td> </tr> <tr class="odd TableStyle-Borders-Body-Row1"> <td class="TableStyle-Borders-BodyB-Regular-Row1">700</td> <td class="TableStyle-Borders-BodyB-Regular-Row1">ApplySort</td> <td class="TableStyle-Borders-BodyA-Regular-Row1">DashboardPanels result is sorted by IsPanel property, then by Order property, and finally by Text property.</td> </tr> </tbody> </table>