Get-NectarReportDetail
- 22 Jul 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarReportDetail
- Updated on 22 Jul 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Returns detail about a given widget within a report
Syntax
Get-NectarReportDetail
-ReportID <Int32>
-ReportWidgetID <Int32>
-WidgetType <String>
-WidgetDescription <String>
-TenantName <String>
Examples
Example 1
Get-NectarReportDetail -ReportID 31 -ReportWidgetID 84
Returns details about the widget with ID 84 on report ID 31
Parameters
-ReportID <Int32>
The numeric ID of the report that contains the desired widget
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-ReportWidgetID <Int32>
The numeric ID of the report widget to get details about
| Parameter | Value |
|---|---|
| Required | true |
| Position | 2 |
| Required | true |
| Default Value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-WidgetType <String>
The type of widget to report on. If not supplied, will be obtained by running Get-NectarReportPreview
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-WidgetDescription <String>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?