Get an Instance

Gets an Instance by ID. The Instance ID can be read off the instance object, or copied from the URL of the instance.

šŸ‘

Permissions Required

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

Method Signature

Instance get(String id);

Paramters

ParameterTypeDescription
idStringThe id of the Instance to get
returnsInstanceThe requested Instance

Example

/*
 * This example demonstrates getting a Workflow Instance by ID
 */
import org.catalytic.sdk.CatalyticClient;
import org.catalytic.sdk.entities.Instance;

public class Program {
  
    public static void main(String[] args) throws Exception {
      
      	// Create and initialize the Catalytic SDK Client
        CatalyticClient catalytic = new CatalyticClient();
      
      	// Get the instance with id e6df431b-1041-4326-89e5-1e14caa6a08g
        Workflow workflow = catalytic.instances().get("e6df431b-1041-4326-89e5-1e14caa6a08g");
    }
}