Skip to content
ConsoleMonster
Cmdlet

New-ConsoleDiagramStep

Module
ConsoleMonster
Inputs
None
Outputs
ConsoleMonster.Widgets.DiagramStep

Creates a request, message, reply or failed interaction.

Syntax

New-ConsoleDiagramStep
[-Failed]
[-From] <String>
[-Kind <Request|Message|Reply|Failed>]
[-Label] <String>
[-Payload <Hashtable>]
[-Reply]
[-To] <String>
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

From and To identify diagram nodes. Payload is a hashtable of fields shown with the active step. Reply and Failed are shorthand for Kind; choose one interaction kind.

Examples

Example 1

New-ConsoleDiagramStep Web 'Orders API' 'create order' -Payload @{ sku = 'MUG-01'; qty = 2 }

A request payload.

Parameters

-Failed SwitchParameter optional
Marks a failed interaction.
-From String requiredposition: 0
The source node id.
-Kind DiagramStepKind optional
Request, Message, Reply or Failed.
Possible values: Request, Message, Reply, Failed
-Label String requiredposition: 2
The interaction text.
-Payload Hashtable optional
Named payload fields.
-Reply SwitchParameter optional
Marks a reply.
-To String requiredposition: 1
The destination node id.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.