Get an Instance Step

The GetStep Method

Gets an Instance Step by ID. The Step ID can be found with the Get Instance Steps or Find Instance Steps calls, or copied from the URL of the Instance Step.

πŸ‘

Permissions Required

You must have Find permissions to the Instance for this request to succeed.

Method Signature

getInstanceStep(id: string): Promise<InstanceStep>;
getInstanceStep(id: string, callback: (err?: Error, step: InstanceStep) => any): void;

Parameters

ParameterTypeDescription
idstringThe id of the Instance Step to get
callback(err?: Error, step: InstanceStep) => anyOptional The callback
returnsInstanceStepThe requested Instance Step

Example

/*
 * This example demonstrates getting an Instance Step by ID
 */
const { CatalyticClient } = require('@catalytic/sdk');

const catalytic = new CatalyticClient();

const step = await catalytic.instances.getInstanceStep('e6df431b-1041-4326-89e5-1e14caa6a08f');