Get-SmaReportingDefinition

NAME Get-SmaReportingDefinition



SYNOPSIS







SYNTAX

Get-SmaReportingDefinition [-Confirm] [-DefinitionID <Int32>] [-QueryParameters <String>] [-WhatIf]

[<CommonParameters>]



Get-SmaReportingDefinition [-Confirm] [-DefinitionName <String>] [-QueryParameters <String>] [-WhatIf]

[<CommonParameters>]



Get-SmaReportingDefinition [-Confirm] [-DistinctField <String>] [-QueryParameters <String>] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

Return reporting definitions





PARAMETERS

-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-DefinitionID <Int32>

Specifies the definition ID to return.



Required? false

Position? named

Default value 0

Accept pipeline input? False

Accept wildcard characters? false



-DefinitionName <String>

Specifies the definition name to return.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DistinctField <String>

Specifies the distinct field to return.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-QueryParameters <String>

Any additional query parameters to be included. String must begin with a '?' character.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

PSCustomObject







NOTES









-------------------------- EXAMPLE 1 --------------------------



Get-SmaReportingDefinition



Returns all reporting definions

-------------------------- EXAMPLE 2 --------------------------



Get-SmaReportingDefinition -DefinitionID 1234 -QueryParameters "?orgID=1"



This will return the reporting definitions for report ID 1234 in ORG 1. Org MUST be specified in the query

parameters.



RELATED LINKS

Online Version: https://github.com/ArtisanByteCrafter/K ... inition.md