Get-BT_ReportInstance

Syntax

Get-BT_ReportInstance -Ticket <Ticket> [-Environment <string>] [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-SystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-ReportMetadataId <Object[]>] [-CustomerId <Object[]>] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-Category <string[]>] [-ReadyToView <string>] [-GenerationState <string[]>] [-GeneratedOn <string[]>] [-SortBy_GeneratedOn_Ascending] [-SortBy_GeneratedOn_Descending] [-StartAt <string[]>] [-SortBy_StartAt_Ascending] [-SortBy_StartAt_Descending] [-EndAt <string[]>] [-SortBy_EndAt_Ascending] [-SortBy_EndAt_Descending] [-Expires <string[]>] [-SortBy_Expires_Ascending] [-SortBy_Expires_Descending] [-RequiresAggregation <string>] [<CommonParameters>]

Get-BT_ReportInstance -Ticket <Ticket> -EndpointUrl <string> [-PageOffset <int>] [-PageSize <int>] [-RetrieveAll] [-ShouldUnmaskProperties <bool>] [-Id <Object[]>] [-IsDeleted <string>] [-Created <string[]>] [-SortBy_Created_Ascending] [-SortBy_Created_Descending] [-Updated <string[]>] [-SortBy_Updated_Ascending] [-SortBy_Updated_Descending] [-Version <Object[]>] [-SortBy_Version_Ascending] [-SortBy_Version_Descending] [-SystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-ReportMetadataId <Object[]>] [-CustomerId <Object[]>] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-Category <string[]>] [-ReadyToView <string>] [-GenerationState <string[]>] [-GeneratedOn <string[]>] [-SortBy_GeneratedOn_Ascending] [-SortBy_GeneratedOn_Descending] [-StartAt <string[]>] [-SortBy_StartAt_Ascending] [-SortBy_StartAt_Descending] [-EndAt <string[]>] [-SortBy_EndAt_Ascending] [-SortBy_EndAt_Descending] [-Expires <string[]>] [-SortBy_Expires_Ascending] [-SortBy_Expires_Descending] [-RequiresAggregation <string>] [<CommonParameters>]

Detailed Description

Get-BT_ReportInstance gets a(an) BT_ReportInstance. Describes an actual generated report.

Parameters

Total Parameters: 52

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Category

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CustomerId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EndAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Environment

Available values are listed below.

Value Description
BT Represents BT
Beta Represents Beta
Develop Represents Develop
Release Represents Release
Test Represents Test
China Represents China
Germany Represents Germany
Alpha Represents Alpha
Today Represents Today
Sandbox-02 Represents Sandbox-02
Sandbox-03 Represents Sandbox-03

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Expires

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

GeneratedOn

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

GenerationState

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Name

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageOffset

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageSize

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReadyToView

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReportMetadataId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RequiresAggregation

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RetrieveAll

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShouldUnmaskProperties

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Created_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Created_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_EndAt_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_EndAt_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Expires_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Expires_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_GeneratedOn_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_GeneratedOn_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Name_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Name_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_StartAt_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_StartAt_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Updated_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Updated_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Version_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Version_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

StartAt

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Updated

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Version

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

WorkgroupOrganizationId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples