ProcessInstances.GetInstanceStatusByIdAsync

Description

The API gets the process instance status of the specified process instance ID inside the connected AI Command Center.

Signature [C#]

Task<string> GetInstanceStatusByIdAsync(string instanceId);

Properties

Input

Parameter	Type	Required / default	Description
instanceId	string	Required	The process instance ID for which the process instance status has to be retrieved.

Output

Property	Description
Task<ProcessInstance>	Returns process instance status.

Remarks

Use GetInstanceStatusByIdAsync API to get process instance status using process instance id inside the connected AI Command Center.

Example

C#

public async Task GetInstanceStatusById()
{
    IControlRoomContext context = LoginControlRoom();
    try
    {
        string instanceId = "e42a93f5d53245d788909fd655b41cfe";
        string status = await context.ProcessInstances.GetInstanceStatusByIdAsync(instanceId);
        System.Console.WriteLine("Status: " + status);
    }
    finally
    {
        context.Close();
    }
}

Connection helper

public IControlRoomContext LoginControlRoom()
{
    string RequiredSetting(string name) => Environment.GetEnvironmentVariable(name) ?? throw new InvalidOperationException($"Set {name} before running this example.");
    string serverUrl = RequiredSetting("INTELLIBUDDIES_SERVER_URL");
    string userName = RequiredSetting("INTELLIBUDDIES_USERNAME");
    string password = RequiredSetting("INTELLIBUDDIES_PASSWORD");
    string connectionString = $"ServerUrl={serverUrl};UserName={userName};Password={password}";
    IControlRoomContext context = new ControlRoomContext(connectionString);
    context.Open();
    return context;
}

See Get started for namespaces, configuration, and context cleanup, and SDK usage for error handling.