{"title":"Codeunit 4303 Agent Task, procedures","url":"https://jonas-paprotka.de/ref/codeunit/4303-agent-task/procedures/","author":"JOP-AL","license":"Metadata from Microsoft's symbol packages. AL source MIT, Copyright (c) Microsoft Corporation. Selection and wording © 2026 JOP-AL. https://jonas-paprotka.de/licenses/","subject":"Microsoft Dynamics 365 Business Central","checked":"2026-11-20","changed":"2026-10-05","object":{"type":"codeunit","id":4303,"name":"Agent Task","app":"System Application","versions":"25-29","url":"https://jonas-paprotka.de/ref/codeunit/4303-agent-task/","json":"https://jonas-paprotka.de/ref/codeunit/4303-agent-task.json"},"aspect":"procedures","total":25,"rows":[{"name":"TaskExists","sig":"(Guid, Text)","named":"(AgentUserSecurityId: Guid; ExternalId: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":26,"named":"(AgentUserSecurityId: Guid; ConversationId: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null},{"from":27,"to":29,"named":"(AgentUserSecurityId: Guid; ExternalId: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"CreateTaskMessage","sig":"(Text[250], Text, Text[2048], var Record Agent Task)","named":"(From: Text[250]; MessageText: Text; ExternalMessageId: Text[2048]; var CurrentAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25","first":25,"last":25,"obsoleteSince":null,"spans":[{"from":25,"to":25,"named":"(From: Text[250]; MessageText: Text; ExternalMessageId: Text[2048]; var CurrentAgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetStatusToReady","sig":"(Record Agent Task)","named":"(AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26","first":26,"last":26,"obsoleteSince":null,"spans":[{"from":26,"to":26,"named":"(AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CanSetStatusToReady","sig":"(Record Agent Task)","named":"(AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetTaskByExternalId","sig":"(Guid, Text)","named":"(AgentUserSecurityId: Guid; ExternalId: Text)","returns":"Record Agent Task","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AgentUserSecurityId: Guid; ExternalId: Text)","returns":"Record Agent Task","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetStatusToReady","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the overload that takes AgentTaskID instead.","tag":"29.0"},"range":"27-29","first":27,"last":29,"obsoleteSince":29,"spans":[{"from":27,"to":28,"named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":29,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the overload that takes AgentTaskID instead.","tag":"29.0"}}]},{"name":"StopTask","sig":"(var Record Agent Task, Boolean)","named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the overload that takes AgentTaskID instead.","tag":"29.0"},"range":"27-29","first":27,"last":29,"obsoleteSince":29,"spans":[{"from":27,"to":28,"named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":29,"to":29,"named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the overload that takes AgentTaskID instead.","tag":"29.0"}}]},{"name":"RestartTask","sig":"(var Record Agent Task, Boolean)","named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the overload that takes AgentTaskID instead.","tag":"29.0"},"range":"27-29","first":27,"last":29,"obsoleteSince":29,"spans":[{"from":27,"to":28,"named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":29,"to":29,"named":"(var AgentTask: Record \"Agent Task\"; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the overload that takes AgentTaskID instead.","tag":"29.0"}}]},{"name":"IsTaskRunning","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskCompleted","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskStopped","sig":"(var Record Agent Task)","named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var AgentTask: Record \"Agent Task\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetStatusToReady","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CanSetStatusToReady","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"StopTask","sig":"(BigInteger, Boolean)","named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RestartTask","sig":"(BigInteger, Boolean)","named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskRunning","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskCompleted","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsTaskStopped","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetCopilotCreditsConsumed","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Decimal","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the methods in the \"Agent Consumption Overview\" codeunit instead.","tag":"29.0"},"range":"28-29","first":28,"last":29,"obsoleteSince":28,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Decimal","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the methods in the \"Agent Consumption Overview\" codeunit instead.","tag":"29.0"}}]},{"name":"GetLogEntryDetails","sig":"(var Record Agent Task Log Entry)","named":"(var AgentTaskLogEntry: Record \"Agent Task Log Entry\")","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(var AgentTaskLogEntry: Record \"Agent Task Log Entry\")","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetModelId","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Code[30]","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Code[30]","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetModelName","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Text[70]","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Text[70]","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetStepsDoneCount","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"OpenAgentTaskLogEntries","sig":"(BigInteger)","named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentTaskID: BigInteger)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ArchiveTask","sig":"(BigInteger, Boolean)","named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"29","first":29,"last":29,"obsoleteSince":null,"spans":[{"from":29,"to":29,"named":"(AgentTaskID: BigInteger; UserConfirm: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}