Get-BT_ReportWithData

Syntax

Get-BT_ReportWithData -ReportInstanceId <guid> -Ticket <Ticket> [-PageSize <int>] [-PageOffset <int>] [-StartAfter <datetime>] [-EndBefore <datetime>] [-CustomerId <guid>] [-Environment <string>] [<CommonParameters>]

Get-BT_ReportWithData -ReportInstanceId <guid> -Ticket <Ticket> -EndpointUrl <string> [-PageSize <int>] [-PageOffset <int>] [-StartAfter <datetime>] [-EndBefore <datetime>] [-CustomerId <guid>] [<CommonParameters>]

Detailed Description

Get-BT_ReportWithData gets a(an) BT_ReportWithData. Represents a MSPComplete report with data. A report represents a snapshots of current state of your business and helps you track it over time.

Parameters

Total Parameters: 20

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ReportInstanceId

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

CustomerId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

EndBefore

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

PageOffset

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PageSize

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

StartAfter

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

T

Ticket should scope to the workgroup with an administrator role or privileged.


Examples

-------------------------- Example 1 -------------------------

# Retrieve a ticket scoped to a workgroup

$credentials = Get-Credential

$btTicket = Get-BT_Ticket -Credentials $credentials -ServiceType BitTitan

$workgroups = Get-BT_Workgroup -Ticket $btTicket

$workgroupTicket = Get-BT_Ticket -Ticket $btTicket -OrganizationId $workgroups[0].WorkgroupOrganizationId

# Retrieve report instances belong to the workgroup, you need to have the administrator role for the account

$reportInstances = Get-BT_ReportInstance -Ticket $workgroupTicket

# Go over the listed report instances and pick the desired one to retrieve data, here for examplary purposes taking the first instance

$desiredReportInstance = $reportInstances[0]

# Retrieve the report with data

$report = Get-BT_ReportWithData -Ticket $workgroupTicket -ReportInstanceId $desiredReportInstance.Id