Modules§
- asset_
field - Nested message and enum types in
AssetField
. - asset_
reference - Nested message and enum types in
AssetReference
. - auto_
proceed_ config - Nested message and enum types in
AutoProceedConfig
. - auto_
start_ config - Nested message and enum types in
AutoStartConfig
. - completion_
action_ config - Nested message and enum types in
CompletionActionConfig
. - form_
field - Nested message and enum types in
FormField
. - nested_
procedure_ node - Nested message and enum types in
NestedProcedureNode
. - procedure_
node - Nested message and enum types in
ProcedureNode
. - procedure_
search_ query - Nested message and enum types in
ProcedureSearchQuery
. - procedure_
step_ content - Nested message and enum types in
ProcedureStepContent
. - procedures_
service_ client - Generated client implementations.
- success_
condition - Nested message and enum types in
SuccessCondition
.
Structs§
- AndSuccess
Condition - All conditions within must be met for the step to be succeeded.
- Archive
Procedures Request - Archive
Procedures Response - Asset
Field - A field to select a single asset.
- Asset
Reference - A reference to an asset, either by rid or by a field in the current or previous steps.
- Auto
Proceed Config - AutoProceedConfig is a configuration that determines whether a step should
automatically proceed (submit the contents and check success_conditions)
when some set of criteria are met. By default this will be
disabled
. - Auto
Start Config - AutoStartConfig is a configuration that determines whether a step should be
automatically moved from NOT_STARTED to IN_PROGRESS when some set of criteria are met.
By default this will be
all_parents
- Checkbox
Field - A field to capture a boolean value.
- Commit
Request - Commit
Response - Completion
Action Config - An action that will be taken when a step transitions to a completed state (succeeded, errored, or skipped). These actions are executed after the step contents are submitted and the PassCondition (if any) is satisfied. These actions are executed synchronously with the state transition and generally should be quick to complete.
- Create
Event Config - An action to create an event when a step is completed.
- Create
Procedure Request - Create
Procedure Response - Form
Field - A field to be filled out by the user.
- Form
Step - A form step consists of a set of fields to be filled out by the user.
- GetProcedure
AsNested Request - GetProcedure
AsNested Response - GetProcedure
Request - GetProcedure
Response - Merge
ToMain Request - Merge
ToMain Response - Nested
Procedure - A simplified version of procedure state that is currently used for procedure authoring. In this form, the graph is a completely linear structure where each step depends solely on the preceding step.
- Nested
Procedure Node - A section or a step in a NestedProcedure.
- Node
List - A list of node IDs.
- Parse
Nested Procedure Request - Parse
Nested Procedure Response - Preset
Asset Field Options - A limited set of options to choose from, with an optional default option.
- Procedure
- A procedure describes a series of steps to be performed, typically in a specific order,
- Procedure
Display Graph - A simpler representation of the procedure graph that is used for display in a UI.
- Procedure
Metadata - Metadata about a procedure that is not part of the versioned state.
- Procedure
Node - A procedure node is either a section or a step.
- Procedure
Search Query - Procedure
Section Node - A procedure section node visually groups other sections and steps.
- Procedure
State - ProcedureState is the versioned state of a procedure template.
- Procedure
Step Content - The content of a procedure step. This typically involves some form of user interaction/input.
- Procedure
Step Node - A procedure step node represents a step in the procedure.
- Save
Working State Request - Save
Working State Response - Search
Procedures Request - Search
Procedures Response - Search
Procedures Sort Options - Success
Condition - The condition that must be met for a step to succeed after submitting its contents.
- Unarchive
Procedures Request - Unarchive
Procedures Response - Update
Procedure Metadata Request - Update
Procedure Metadata Response