<PackageReference Include="Relativity.Server.Services.Interfaces.SDK" Version="5000.0.2" />

IAgentManager

public interface IAgentManager : IDisposable
Exposes methods for creating, reading, updating, and deleting agents, as well as various helper methods.
Task<int> CreateAsync(int workspaceID, AgentRequest agentRequest)

Adds a single agent to Relativity.

Task<List<int>> CreateAsync(int workspaceID, AgentRequest agentRequest, int count)

Adds multiple copies of an agent to Relativity.

Task DeleteAsync(int workspaceID, int agentID)

Removes an agent after it finishes executing.

Task DeleteAsync(int workspaceID, int agentID, bool force)

Removes an agent conditionally waiting for it to finish executing.

Task<List<AgentServerResponse>> GetAgentServersAsync(int workspaceID)

Retrieves a list of all agent servers in a Relativity environment.

Task<List<AgentTypeResponse>> GetAgentTypesAsync(int workspaceID)

Retrieves a list of agent types.

Task<List<AgentServerResponse>> GetAvailableAgentServersAsync(int workspaceID, int agentTypeID)

Uses the Artifact ID of a specific agent type to retrieve a list of compatible agent servers.

Task<List<AgentServerResponse>> GetAvailableAgentServersAsync(int workspaceID, Guid agentTypeGuid)

Uses the GUID of a specific agent type to retrieve a list of compatible agent servers.

Task<AgentResponse> ReadAsync(int workspaceID, int agentID)

Retrieves basic metadata for an agent, including its name, type, interval, and other properties.

Task<AgentResponse> ReadAsync(int workspaceID, int agentID, bool includeMetadata, bool includeActions)

Retrieves extended metadata for an agent, including information about additional actions available.

Task UpdateAsync(int workspaceID, int agentID, AgentRequest agentRequest)

Modifies the properties of an agent.

Task UpdateAsync(int workspaceID, int agentID, AgentRequest agentRequest, DateTime lastModifiedOn)

Restricts updates to the properties of the agent to the date that it was last modified

Task<List<AgentInstanceLimitResult>> ValidateCreateInstanceLimitAsync(int workspaceID, AgentRequest agentRequest, int count)

Indicates whether adding a new agent exceeds the limits for the agent type in a Relativity environment or server.

Task<List<AgentInstanceLimitResult>> ValidateDeleteInstanceLimitAsync(int workspaceID, int agentID)

Indicates whether deleting an agent violates the lower limit for an agent type in a Relativity environment, resource pool, or server.

Task<List<AgentInstanceLimitResult>> ValidateUpdateInstanceLimitAsync(int workspaceID, int agentID, AgentRequest agentRequest)

Indicates whether modifying an agent violates the minimum or maximum limit for the agent type in a Relativity environment, resource pool, or server.