Get-BT_RecurrentWorkflowRule

Syntax

Get-BT_RecurrentWorkflowRule -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[]>] [-OrganizationId <Object[]>] [-Type <Object[]>] [-SortBy_Type_Ascending] [-SortBy_Type_Descending] [-Enabled <string>] [-RecurrenceStartTime <string[]>] [-SortBy_RecurrenceStartTime_Ascending] [-SortBy_RecurrenceStartTime_Descending] [-NextOccurrenceTime <string[]>] [-SortBy_NextOccurrenceTime_Ascending] [-SortBy_NextOccurrenceTime_Descending] [-RecurrenceFrequency <string[]>] [-RecurrenceInterval <Object[]>] [-SortBy_RecurrenceInterval_Ascending] [-SortBy_RecurrenceInterval_Descending] [-AllowConcurrentInstances <string>] [-WorkflowType <Object[]>] [-SortBy_WorkflowType_Ascending] [-SortBy_WorkflowType_Descending] [-WorkflowReferenceId <Object[]>] [-SortBy_WorkflowReferenceId_Ascending] [-SortBy_WorkflowReferenceId_Descending] [-WorkflowData <Object[]>] [-SortBy_WorkflowData_Ascending] [-SortBy_WorkflowData_Descending] [-RuleType <string[]>] [<CommonParameters>]

Get-BT_RecurrentWorkflowRule -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[]>] [-OrganizationId <Object[]>] [-Type <Object[]>] [-SortBy_Type_Ascending] [-SortBy_Type_Descending] [-Enabled <string>] [-RecurrenceStartTime <string[]>] [-SortBy_RecurrenceStartTime_Ascending] [-SortBy_RecurrenceStartTime_Descending] [-NextOccurrenceTime <string[]>] [-SortBy_NextOccurrenceTime_Ascending] [-SortBy_NextOccurrenceTime_Descending] [-RecurrenceFrequency <string[]>] [-RecurrenceInterval <Object[]>] [-SortBy_RecurrenceInterval_Ascending] [-SortBy_RecurrenceInterval_Descending] [-AllowConcurrentInstances <string>] [-WorkflowType <Object[]>] [-SortBy_WorkflowType_Ascending] [-SortBy_WorkflowType_Descending] [-WorkflowReferenceId <Object[]>] [-SortBy_WorkflowReferenceId_Ascending] [-SortBy_WorkflowReferenceId_Descending] [-WorkflowData <Object[]>] [-SortBy_WorkflowData_Ascending] [-SortBy_WorkflowData_Descending] [-RuleType <string[]>] [<CommonParameters>]

Detailed Description

Get-BT_RecurrentWorkflowRule gets a(an) BT_RecurrentWorkflowRule. Represents a recurrent workflow rule in the Async Execution Framework.

Parameters

Total Parameters: 56

EndpointUrl

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Ticket

Paremeter specs:

Required True
ValueFromPipeline False
ValueFromPipelineByPropertyName False

AllowConcurrentInstances

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Created

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Enabled

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

NextOccurrenceTime

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

OrganizationId

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

RecurrenceFrequency

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RecurrenceInterval

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RecurrenceStartTime

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RetrieveAll

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

RuleType

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_NextOccurrenceTime_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_NextOccurrenceTime_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_RecurrenceInterval_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_RecurrenceInterval_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_RecurrenceStartTime_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_RecurrenceStartTime_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Type_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_Type_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

SortBy_WorkflowData_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_WorkflowData_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_WorkflowReferenceId_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_WorkflowReferenceId_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_WorkflowType_Ascending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SortBy_WorkflowType_Descending

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

SystemUserId

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

WorkflowData

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

WorkflowReferenceId

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

WorkflowType

Paremeter specs:

Required False
ValueFromPipeline False
ValueFromPipelineByPropertyName False

Outputs

System.Object

Notes

Examples