ToolWheel.Extensions.JobManager.API 1.0.0-preview6

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of ToolWheel.Extensions.JobManager.API. 
dotnet add package ToolWheel.Extensions.JobManager.API --version 1.0.0-preview6
                    


                    

                
NuGet\Install-Package ToolWheel.Extensions.JobManager.API -Version 1.0.0-preview6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ToolWheel.Extensions.JobManager.API" Version="1.0.0-preview6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ToolWheel.Extensions.JobManager.API" Version="1.0.0-preview6" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ToolWheel.Extensions.JobManager.API" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ToolWheel.Extensions.JobManager.API --version 1.0.0-preview6
                    


                    

                
#r "nuget: ToolWheel.Extensions.JobManager.API, 1.0.0-preview6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package ToolWheel.Extensions.JobManager.API@1.0.0-preview6
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ToolWheel.Extensions.JobManager.API&version=1.0.0-preview6&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ToolWheel.Extensions.JobManager.API&version=1.0.0-preview6&prerelease
                    


                            Install as a Cake Tool

ToolWheel.Extensions.JobManager.API

ASP.NET Core controllers and a typed HTTP client for the ToolWheel Job Manager REST API. This package provides the server-side endpoints for monitoring and controlling jobs, as well as the client-side extension methods for consuming them remotely.

Package Info

Property Value
Target Framework net8.0
NuGet Package ID ToolWheel.Extensions.JobManager.API
Project References ToolWheel.Extensions.JobManager, ToolWheel.Extensions.JobManager.Abstractions.API
Package Dependencies Microsoft.AspNetCore.Mvc, Refit

REST Endpoints

Jobs � JobController

Method Route Description
GET /api/job Returns all registered jobs.
GET /api/job/{jobId} Returns a single job by ID.
PUT /api/job Updates name, description and enabled-flag of a job.
POST /api/job/{jobId}/execute Triggers execution of a job; returns the created JobTask.

Job Tasks � JobTaskController

Method Route Description
GET /api/job/tasks Returns all job tasks across all jobs.
GET /api/job/{jobId}/task Returns all tasks for a specific job.
GET /api/job/{jobId}/task/{taskId} Returns a single task by job ID and task ID.

Server Usage

Reference this package together with ToolWheel.Extensions.JobManager.Abstractions.API and call UseJobManagerRestApi on the host builder:

Host.CreateDefaultBuilder(args)
    .UseJobManagerRestApi(listenPort: 8080)
    .ConfigureServices(services =>
    {
        services.AddJobManager(configure =>
        {
            configure.ConfigureJobs(jobs =>
            {
                jobs.Add("my-job", new MyWorker().DoWork)
                    .Name("My Job")
                    .Enabled();
            });
        });
    })
    .Build()
    .Run();

Client Usage

Use JobManagerClient from ToolWheel.Extensions.JobManager.Abstractions.API together with the extension methods from this package:

var client = new JobManagerClient("http://localhost:8080");

// Jobs
IEnumerable<JobModel> jobs = await client.ReadJobsAsync();
JobModel job = await client.ReadJobAsync("my-job");

// Update (name, description, enabled)
job.Enabled = false;
JobModel updated = await client.UpdateAsync(job);

// Execute
JobTaskModel task = await client.ExecuteAsync("my-job");

// Tasks
IEnumerable<JobTaskModel> allTasks    = await client.ReadJobTasksAsync();
IEnumerable<JobTaskModel> jobTasks    = await client.ReadJobTasksAsync("my-job");

Models

JobModel

Property Type Description
JobId string Unique identifier of the job (read-only).
Name string Display name.
Description string Short description.
Enabled bool Whether the job is enabled.

JobTaskModel

Represents a single execution instance of a job with its current status, result and journal entries.

DTOs

Internal DTOs (JobGetDto, JobPutDto, JobTaskGetDto, JobConditionStatusDto) are used for JSON serialisation between server and client. The DtoConverter class maps between DTOs and the domain models (JobModel, JobTaskModel).

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-preview6 51 3/26/2026