Process.GetProcessVersionByGuid

Description

This API gets the latest or active version of the specified process from the connected AI Command Center.

Signature [C#]

Task<string> GetProcessDefVersionByGuid(string processGuid, bool getLatestVersion = false);

Properties

Input

Parameter	Type	Required / default	Description
processGuid	string	Required	Specify the GUID of the process to be retrieved.
getLatestVersion	bool	Optional; false	Set to true for the latest version; false requests the active version.

Output

Property	Description
Task<string>	Returns the value that indicates the version of the process.

Remarks

Use GetProcessDefVersionByGuid API to get the latest or the currently active version of the specified process from the connected AI Command Center.

Example

C#

public async Task GetProcessDefVersionByGuid()
{
    IControlRoomContext context = LoginControlRoom();
    try
    {
        string processGuid = "9E364235-D7A2-4845-97A8-0FC26E1D428B";
        bool getLatestVersion = true;
        var processVersion = await context.Processes.GetProcessDefVersionByGuid(processGuid, getLatestVersion);
        Console.WriteLine("Process version: " + processVersion);
    }
    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.