Complete an Instance Step
Complete an instance step that is currently Active. If the step is configured with output fields, you can set the values of those output fields while completing the step.
Permissions Required
You must have admin access to the Instance, or be an assignee for the Step for this request to succeed
Method Signature
completeStep(string $id, array $fields = null): InstanceStep
Parameters
| Parameter | Type | Description |
|---|---|---|
$id | string | The ID of the Instance Step to complete |
$fields | array | Optional named fields to set on the InstanceStep. Must match Fields configured on the InstanceStep. |
| returns | InstanceStep | The completed Instance Step |
Example
<?php
/*
* Demonstrates completing a Step in a Workflow Instance
*/
require_once(__DIR__ . '/vendor/autoload.php');
use Catalytic\SDK\CatalyticClient;
$catalytic = new CatalyticClient();
$step = $catalytic->instances()->completeStep('dc0ca16c-789c-402f-9a8e-b29a79a9bcc1');
Updated over 3 years ago