Complete an Instance Step
$ catalytic instance complete step <StepId> [--field=<exp>... | --fieldsJson=<pathToJSONFile> | --fieldsViaStdIn] [--format=<FormatExpression>] [--credentials=<CredentialsName>]
This command completes an Instance Step by Id, optionally including Fields.
You must be the Instance Step assignee or an Instance admin to perform this command.
Option | Description |
---|---|
<StepId> | The Catalytic system ID of the Instance Step to complete. |
--field=<exp> | Field value to add to the Instance in the form of fieldName:value (i.e. --field=first-name:alice). Multiple --field=<exp> arguments may be provided. |
--fieldsViaStdIn | Boolean flag which will prompt for JSON fields input via StdIn. |
--fieldsJson=<pathToJSONFile> | Path to a file containing fields in JSON format. |
--format=<FormatExpression> | A FormatExpression to define the output style and properties. See Formatting Output and Instance Step Properties for more information. |
--credentials=<CredentialsName> | A string corresponding to saved Credentials. See Using Credentials for more information about Authentication. |
Example
Complete Instance Step with Id 10000000-0000-0000-0000-000000000000
, setting the "Invoice Amount" field to 1000
and the "Invoice Vendor" field to Dunder Mifflin
.
$ catalytic instance complete 10000000-0000-0000-0000-000000000000 --field 'invoice-amount:1000' --field 'invoice-vendor:Dunder Mifflin'
Updated almost 3 years ago