ProcessInstances.GetActivityInstanceByIdAsync

Description

The API gets an activity instance of a specified activity ID inside the connected AI Command Center.

Signature [C#]

Task<ActivityInstance> GetActivityInstanceByIdAsync(string processInstanceId, string activityId);

Properties

Input

Parameter	Type	Required / default	Description
processInstanceId	string	Required	The process instance id in which the activity instance is located.
activityId	string	Required	The activity ID for which the activity instance has to be retrieved.

Output

Property	Description
Task<ActivityInstance>	Returns activity instance.

Remarks

Use GetActivityInstanceByIdAsync API to get the activity instance of a process instance inside the connected AI Command Center.

Example

C#

public async Task GetActivityInstanceById()
{
    IControlRoomContext context = LoginControlRoom();
    try
    {
        string processInstanceId = "e42a93f5d53245d788909fd655b41cfe";
        string activityId = "58bfe04d347540188dfdb55f2e16f5ec";
        ActivityInstance activityInstance = await context.ProcessInstances.GetActivityInstanceByIdAsync(processInstanceId, activityId);
        System.Console.WriteLine("Activity Name: " + activityInstance.Name);
    }
    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.