Workflow Commands

Overview

Catalytic Workflow

Usage:
    catalytic workflow (help | -h | --help)
    catalytic workflow get <Id> [--format=<FormatExpression>] [--credentials=<CredentialsName>]
    catalytic workflow get fields <Id> [--format=<FormatExpression>] [--credentials=<CredentialsName>]
    catalytic workflow get steps <Id> [--format=<FormatExpression>] [--credentials=<CredentialsName>]
    catalytic workflow list [--filter=<FilterExpression>] [--search=<query>] [--max-size=<size>] [--after=<token>] [--format=<FormatExpression>] [--credentials=<CredentialsName>]

Options:
    -h --help                        Show help.
    <Id>                             The Catalytic system ID of the Workflow.
    --filter=<FilterExpression>      A FilterExpression to narrow results. See documentation for more info.
    --format=<FormatExpression>      A FormatExpression to define output style and properties. See documentation for more info.
    --search=<query>                 A search query to limit results.
    --max-size=<size>                The number of results to return with each request [Default: 25]
    --after=<token>                  The next page token of the previous request
    --credentials=<CredentialsName>  The name associated with the Catalytic Credentials to use when querying for Workflow Instances. If left unspecified, the default Credentials will be used.

Workflow Properties

Name	Type	Description	Included by Default
`Id`	`Guid`	The unique ID of the Workflow	true
`Name`	`string`	The descriptive name of the Workflow	true
`Description`	`string`	A description of what the Workflow does	true
`Category`	`string`	A descriptive grouping for your Workflow	true
`Owner`	`string`	The email address of the user who is the primary admin for this `Workflow`. This user will receive fix tasks when there is a problem in an `Instance` of this `Workflow`	true
`IsPublished`	`bool`	Indicates whether the Workflow is published or is in draft mode	true
`IsArchived`	`bool`	Indicates whether is Archived and no longer available for users to find, start or edit.	true
`InputFields`	`FieldsCollection`	A collection of the required and optional input fields that can be passed to this Workflow when starting it.
`FieldVisibility`	`FieldVisibility`	The default visibility level of fields for this Workflow `Public`, `Internal`, `Confidential` or `HighlyConfidential`
`InstanceVisibility`	`InstanceVisibility`	The visibility level of this Workflow `Open` or `Restricted`
`AdminUsers`	`List<string>`	The users or groups who who may view, start, and edit this `Workflow`. Users will be represented by their `Email`, groups by their group name (starting with `g_`).
`StandardUsers`	`List<string>`	The users or groups who who may view and start this `Workflow`. Users will be represented by their `Email`, groups by their group name (starting with `g_`).
`CreatedBy`	`string`	The email address of the user who created this `Workflow`

Field Properties

Name	Type	Description	Included by Default
`Id`	`Guid`	The unique ID of the Field	true
`Name`	`string`	The descriptive name of the Field	true
`ReferenceName`	`string`	The sluggified name of the field	true
`Description`	`string`	A description of the Field, or instructions for filling out the Field in a form	true
`FieldType`	`FieldType`	An enum representing the type of data held in the field.	true
`Type`	`Type`	The dotnet runtime Type of the data held in the field.
`HasValue`	`bool`	Indicates whether the field has a value.
`Restrictions`	`FieldRestrictions`	May include a set of string `Choices` for `SingleChoice` and `MultipleChoice` fields.