Stop an Instance
Stops a running Instance of a Workflow.
Permissions Required
Find and Edit permissions are required for an Instance in order to stop it. The Instance Owner has implicit Find and Edit permissions, and can always stop Instances they own.
Method Signature
Instance Stop(Guid id);
async Task<Instance> StopAsync(Guid id);
Parameters
| Parameter | Type | Description |
|---|---|---|
id | Guid | The id of the Instance to stop |
| returns | Instance | The stopped Instance |
Instance Stop(string id);
async Task<Instance> StopAsync(string id);
| Parameter | Type | Description |
|---|---|---|
id | string | The id of the Instance to stop |
| returns | Instance | The stopped Instance |
Example
/*
* This example demonstrates stopping an Instance by ID
*/
using Catalytic.Sdk.Entities;
namespace Catalytic.Sdk.Examples
{
class Program
{
static void Main(string[] args)
{
var catalytic = new Catalytic.Sdk.CatalyticClient(Credentials.Default);
var instance = catalytic.Instances.Stop("c9f2beec-10c0-4f2f-b4e0-1d884c7e053c");
}
}
}
Updated over 2 years ago