Get-BT_Workgroup

Syntax

Get-BT_Workgroup -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] [-CreatedBySystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-DefaultPaymentProfileId <Object[]>] [-HasHadPaymentProfile <string>] [-ExchangeRateId <Object[]>] [-CouponReedemingStatus <string[]>] [-HasOptOutDistributorSuggestion <string>] [-NetTermsPaymentDays <Object[]>] [-SortBy_NetTermsPaymentDays_Ascending] [-SortBy_NetTermsPaymentDays_Descending] [-PlanType <string[]>] [-SkipChargesUntil <string[]>] [-SortBy_SkipChargesUntil_Ascending] [-SortBy_SkipChargesUntil_Descending] [-BillingStatus <string[]>] [-TrialPlanType <string[]>] [-TrialPlanEndDate <string[]>] [-SortBy_TrialPlanEndDate_Ascending] [-SortBy_TrialPlanEndDate_Descending] [-BillingGracePeriodEndDate <string[]>] [-SortBy_BillingGracePeriodEndDate_Ascending] [-SortBy_BillingGracePeriodEndDate_Descending] [-CustomerCreated <string[]>] [-CustomerUpdated <string[]>] [-CustomerSystemUserId <Object[]>] [-CustomerOrganizationId <Object[]>] [-CustomerPrimaryDomain <Object[]>] [-CustomerCompanyName <Object[]>] [-CustomerCountryName <Object[]>] [-CustomerStateProvinceName <Object[]>] [-CustomerCityName <Object[]>] [-CustomerIndustryType <string[]>] [-CustomerCompanySizeBucket <string[]>] [-CustomerShortId <Object[]>] [-CustomerIsArchived <string>] [-CustomerCustomerSubscriptionRenewalPolicy <string[]>] [-CustomerLastAccessed <string[]>] [-CustomerIsDefaultCustomer <string>] [-CustomerIsDemoCustomer <string>] [-CustomerWorkgroupId <Object[]>] [-CustomerProjectStatsCreated <string[]>] [-CustomerProjectStatsUpdated <string[]>] [-CustomerProjectStatsSystemUserId <Object[]>] [-CustomerProjectStatsOrganizationId <Object[]>] [-CustomerProjectStatsName <Object[]>] [-CustomerProjectStatsStatus <string[]>] [-CustomerProjectStatsApplicationServiceId <Object[]>] [-CustomerProjectStatsIsNotGenerated <string>] [-CustomerProjectStatsApplicationServiceType <string[]>] [-CustomerProjectStatsExternalProjectId <Object[]>] [-CustomerProjectStatsOfferingInstanceId <Object[]>] [-CustomerExtendedPropertyCreated <string[]>] [-CustomerExtendedPropertyUpdated <string[]>] [-CustomerExtendedPropertySystemUserId <Object[]>] [-CustomerExtendedPropertyReferenceEntityType <Object[]>] [-CustomerExtendedPropertyReferenceEntityId <Object[]>] [-CustomerExtendedPropertyName <Object[]>] [-CustomerExtendedPropertyIsEncrypted <string>] [-CustomerExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Get-BT_Workgroup -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] [-CreatedBySystemUserId <Object[]>] [-WorkgroupOrganizationId <Object[]>] [-Name <Object[]>] [-SortBy_Name_Ascending] [-SortBy_Name_Descending] [-DefaultPaymentProfileId <Object[]>] [-HasHadPaymentProfile <string>] [-ExchangeRateId <Object[]>] [-CouponReedemingStatus <string[]>] [-HasOptOutDistributorSuggestion <string>] [-NetTermsPaymentDays <Object[]>] [-SortBy_NetTermsPaymentDays_Ascending] [-SortBy_NetTermsPaymentDays_Descending] [-PlanType <string[]>] [-SkipChargesUntil <string[]>] [-SortBy_SkipChargesUntil_Ascending] [-SortBy_SkipChargesUntil_Descending] [-BillingStatus <string[]>] [-TrialPlanType <string[]>] [-TrialPlanEndDate <string[]>] [-SortBy_TrialPlanEndDate_Ascending] [-SortBy_TrialPlanEndDate_Descending] [-BillingGracePeriodEndDate <string[]>] [-SortBy_BillingGracePeriodEndDate_Ascending] [-SortBy_BillingGracePeriodEndDate_Descending] [-CustomerCreated <string[]>] [-CustomerUpdated <string[]>] [-CustomerSystemUserId <Object[]>] [-CustomerOrganizationId <Object[]>] [-CustomerPrimaryDomain <Object[]>] [-CustomerCompanyName <Object[]>] [-CustomerCountryName <Object[]>] [-CustomerStateProvinceName <Object[]>] [-CustomerCityName <Object[]>] [-CustomerIndustryType <string[]>] [-CustomerCompanySizeBucket <string[]>] [-CustomerShortId <Object[]>] [-CustomerIsArchived <string>] [-CustomerCustomerSubscriptionRenewalPolicy <string[]>] [-CustomerLastAccessed <string[]>] [-CustomerIsDefaultCustomer <string>] [-CustomerIsDemoCustomer <string>] [-CustomerWorkgroupId <Object[]>] [-CustomerProjectStatsCreated <string[]>] [-CustomerProjectStatsUpdated <string[]>] [-CustomerProjectStatsSystemUserId <Object[]>] [-CustomerProjectStatsOrganizationId <Object[]>] [-CustomerProjectStatsName <Object[]>] [-CustomerProjectStatsStatus <string[]>] [-CustomerProjectStatsApplicationServiceId <Object[]>] [-CustomerProjectStatsIsNotGenerated <string>] [-CustomerProjectStatsApplicationServiceType <string[]>] [-CustomerProjectStatsExternalProjectId <Object[]>] [-CustomerProjectStatsOfferingInstanceId <Object[]>] [-CustomerExtendedPropertyCreated <string[]>] [-CustomerExtendedPropertyUpdated <string[]>] [-CustomerExtendedPropertySystemUserId <Object[]>] [-CustomerExtendedPropertyReferenceEntityType <Object[]>] [-CustomerExtendedPropertyReferenceEntityId <Object[]>] [-CustomerExtendedPropertyName <Object[]>] [-CustomerExtendedPropertyIsEncrypted <string>] [-CustomerExtendedPropertyWorkgroupOrganizationId <Object[]>] [<CommonParameters>]

Detailed Description

Get-BT_Workgroup gets a(an) BT_Workgroup. A workgroup is managing a list of customers. A workgroup may be associated with a payment profile. It also has a Plan Type which defines the level of features enabled in MSPC. Each master system user has access to one workgroup at least. A system user can invite somebody to manage his/her workgroup. A workgroup represents an environment containing sets of customers, end users, teams, and member information.

Parameters

Total Parameters: 91

EndpointUrl

Paremeter specs:

Ticket

Paremeter specs:

BillingGracePeriodEndDate

Paremeter specs:

BillingStatus

Paremeter specs:

CouponReedemingStatus

Paremeter specs:

Created

Paremeter specs:

CreatedBySystemUserId

Paremeter specs:

DefaultPaymentProfileId

Paremeter specs:

Environment

Available values are listed below.

Paremeter specs:

ExchangeRateId

Paremeter specs:

HasHadPaymentProfile

Paremeter specs:

HasOptOutDistributorSuggestion

Paremeter specs:

Id

Paremeter specs:

IsDeleted

Paremeter specs:

Name

Paremeter specs:

NetTermsPaymentDays

Paremeter specs:

PageOffset

Paremeter specs:

PageSize

Paremeter specs:

PlanType

Paremeter specs:

RetrieveAll

Paremeter specs:

ShouldUnmaskProperties

Paremeter specs:

SkipChargesUntil

Paremeter specs:

SortBy_BillingGracePeriodEndDate_Ascending

Paremeter specs:

SortBy_BillingGracePeriodEndDate_Descending

Paremeter specs:

SortBy_Created_Ascending

Paremeter specs:

SortBy_Created_Descending

Paremeter specs:

SortBy_Name_Ascending

Paremeter specs:

SortBy_Name_Descending

Paremeter specs:

SortBy_NetTermsPaymentDays_Ascending

Paremeter specs:

SortBy_NetTermsPaymentDays_Descending

Paremeter specs:

SortBy_SkipChargesUntil_Ascending

Paremeter specs:

SortBy_SkipChargesUntil_Descending

Paremeter specs:

SortBy_TrialPlanEndDate_Ascending

Paremeter specs:

SortBy_TrialPlanEndDate_Descending

Paremeter specs:

SortBy_Updated_Ascending

Paremeter specs:

SortBy_Updated_Descending

Paremeter specs:

SortBy_Version_Ascending

Paremeter specs:

SortBy_Version_Descending

Paremeter specs:

TrialPlanEndDate

Paremeter specs:

TrialPlanType

Paremeter specs:

Updated

Paremeter specs:

Version

Paremeter specs:

WorkgroupOrganizationId

Paremeter specs:

Outputs

System.Object

Notes

D

Every BitTitan account is associated with at least one workgroup called the default workgroup. The default workgroup has no name and you can retrieve it with the following parameter: -FilterBy_String_Name "isnull".

Examples

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

# Retrieve the default workgroup, which does not have any name and can be retrieved with the "isnull" operator

Get-BT_Workgroup -Ticket $btTicket -Name "isnull"