Get-BT_Organization

Syntax

Get-BT_Organization -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] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-Type <string[]>] [-PurgePeriod <Object[]>] [-SortBy_PurgePeriod_Ascending] [-SortBy_PurgePeriod_Descending] [-PurgeDate <string[]>] [-SortBy_PurgeDate_Ascending] [-SortBy_PurgeDate_Descending] [-IsProvisioned <string>] [-ShortName <Object[]>] [-SortBy_ShortName_Ascending] [-SortBy_ShortName_Descending] [<CommonParameters>]

Get-BT_Organization -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] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-Type <string[]>] [-PurgePeriod <Object[]>] [-SortBy_PurgePeriod_Ascending] [-SortBy_PurgePeriod_Descending] [-PurgeDate <string[]>] [-SortBy_PurgeDate_Ascending] [-SortBy_PurgeDate_Descending] [-IsProvisioned <string>] [-ShortName <Object[]>] [-SortBy_ShortName_Ascending] [-SortBy_ShortName_Descending] [<CommonParameters>]

Detailed Description

Get-BT_Organization gets a(an) BT_Organization. Represents an organization. An organization represents a scope for a BitTitan ticket, which can be associated with either a customer or a workgroup.

Parameters

Total Parameters: 43

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

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

Id

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsDeleted

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

IsProvisioned

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

PurgeDate

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

PurgePeriod

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RetrieveAll

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

ShortName

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_Name_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Name_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_PurgeDate_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_PurgeDate_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_PurgePeriod_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_PurgePeriod_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_ShortName_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_ShortName_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

Type

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

Outputs

System.Object

Notes

O

The two main organization types are Production and Workgroup.

Production means that the organization is associated with a customer while Workgroup means that the organization is associated with a workgroup.


Examples

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

Get-BT_Organization -Ticket $btTicket -Type "Workgroup"