Start-NectarReport
- 22 Jul 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Start-NectarReport
- 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
Triggers the processing of a report
Syntax
Start-NectarReport
-ID <Int32>
-TenantName <String>
Examples
Example 1
Start-NectarReport -ID 31
Triggers the execution of report with ID 31
Get-NectarReport Test | Start-NectarReport
Triggers the execution of any report with 'Test' in the name
Parameters
-ID <Int32>
The numeric ID of the report to start
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | 0 |
| 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 | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?