Get-CrmProcess.md

external help file	Module Name	online version	schema
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml	AMSoftware.Crm	https://github.com/AMSoftwareNL/crmpowershell/blob/master/docs/Get-CrmProcess.md	2.0.0

Get-CrmProcess

SYNOPSIS

Get Workflow, Dialog, BusinessRule, Action or BusinessProcessFlow.

SYNTAX

GetAllProcesses (Default)

Get-CrmProcess [[-Name] <String>] [-Exclude <String>] [[-Entity] <String>] [[-ProcessType] <CrmProcessType>]
 [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

GetProcessById

Get-CrmProcess [-Id] <Guid[]> [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

DESCRIPTION

Get Workflow, Dialog, BusinessRule, Action or BusinessProcessFlow.

EXAMPLES

Example 1

PS C:\> Get-CrmProcess -ProcessType Workflow

Get all workflows in the connected organization.

PARAMETERS

-Entity

The logicalname of the entity to retrieve the records from.

Type: System.String
Parameter Sets: GetAllProcesses
Aliases:

Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Exclude

Exclude processes whose name matches the provided pattern.

Type: System.String
Parameter Sets: GetAllProcesses
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Id

The id of the process to retrieve.

Type: System.Guid[]
Parameter Sets: GetProcessById
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The name of the process to retrieve.

Type: System.String
Parameter Sets: GetAllProcesses
Aliases: Include

Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-ProcessType

The type of process to retrieve. If not provide all processes will be returned.

Type: AMSoftware.Crm.PowerShell.Common.CrmProcessType
Parameter Sets: GetAllProcesses
Aliases:
Accepted values: Workflow, Dialog, BusinessRule, Action, BusinessProcessFlow, All

Required: False
Position: 30
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeTotalCount

Return the total count (and accuracy) of the number of records before returning the result.

Because of the limitations of Dynamics CRM, the total count is only returned accurate when the result is limited to 5000 items.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips (does not return) the specified number of records.

Type: System.UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-First

Specifies the number of records to retrieve from the beginning.

Type: System.UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Guid[]

OUTPUTS

Microsoft.Xrm.Sdk.Entity

NOTES

RELATED LINKS

Start-CrmProcess

Stop-CrmProcess

Entity Class