quickstarts/jobs/csharp/http

Dapr Jobs API (HTTP Client)

In this quickstart, you'll schedule, get, and delete a job using Dapr's Job API. This API is responsible for scheduling and running jobs at a specific time or interval.

Visit this link for more information about Dapr and the Jobs API.

Note: This example leverages HTTP requests only. If you are looking for the example using the Dapr Client SDK (recommended) click here.

This quickstart includes two apps:

• Jobs Scheduler, responsible for scheduling, retrieving and deleting jobs.
• Jobs Service, responsible for handling the triggered jobs.

Run all apps with multi-app run template file

This section shows how to run both applications at once using multi-app run template files with dapr run -f .. This enables to you test the interactions between multiple applications and will schedule, run, get, and delete jobs within a single process.

1. Build the apps:

cd ./job-service
dotnet build

cd ./job-scheduler
dotnet build

2. Run the multi app run template:

dapr run -f .

The terminal console output should look similar to this, where:

• The R2-D2 job is being scheduled.
• The R2-D2 job is being retrieved.
• The C-3PO job is being scheduled.
• The C-3PO job is being retrieved.
• The R2-D2 job is being executed after 15 seconds.
• The C-3PO job is being executed after 20 seconds.

== APP - job-scheduler == Job Scheduled: R2-D2
== APP - job-scheduler == Job details: {"name":"R2-D2", "dueTime":"15s", "data":{"@type":"type.googleapis.com/google.protobuf.Value", "value":{"Value":"R2-D2:Oil Change"}}}
== APP - job-scheduler == Job Scheduled: C-3PO
== APP - job-scheduler == Job details: {"name":"C-3PO", "dueTime":"20s", "data":{"@type":"type.googleapis.com/google.protobuf.Value", "value":{"Value":"C-3PO:Limb Calibration"}}}
== APP - job-service == Received job request...
== APP - job-service == Starting droid: R2-D2
== APP - job-service == Executing maintenance job: Oil Change

After 20 seconds, the terminal output should present the C-3PO job being processed:

== APP - job-service == Received job request...
== APP - job-service == Starting droid: C-3PO
== APP - job-service == Executing maintenance job: Limb Calibration

Run apps individually

Schedule Jobs

1. Open a terminal and run the job-service app. Build the dependencies if you haven't already.

cd ./job-service
dotnet build

dapr run --app-id job-service --app-port 6200 --dapr-http-port 6280 -- dotnet run

2. In a new terminal window, schedule the R2-D2 Job using the Jobs API.

curl -X POST \
  http://localhost:6280/v1.0-alpha1/jobs/r2-d2 \
  -H "Content-Type: application/json" \
  -d '{
        "data": {
          "Value": "R2-D2:Oil Change"
        },
        "dueTime": "2s"
    }'

In the job-service terminal window, the output should be:

== APP - job-app == Received job request...
== APP - job-app == Starting droid: R2-D2
== APP - job-app == Executing maintenance job: Oil Change

3. On the same terminal window, schedule the C-3PO Job using the Jobs API.

curl -X POST \
  http://localhost:6280/v1.0-alpha1/jobs/c-3po \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "Value": "C-3PO:Limb Calibration"
    },
    "dueTime": "30s"
  }'

Get a scheduled job

1. On the same terminal window, run the command below to get the recently scheduled C-3PO job.

curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json"

You should see the following:

{"name":"c-3po", "dueTime":"30s", "data":{"@type":"type.googleapis.com/google.protobuf.Value", "value":{"Value":"C-3PO:Limb Calibration"}}

Delete a scheduled job

1. On the same terminal window, run the command below to deleted the recently scheduled C-3PO job.

curl -X DELETE http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json" 

2. Run the command below to attempt to retrieve the deleted job:

curl -X GET http://localhost:6280/v1.0-alpha1/jobs/c-3po -H "Content-Type: application/json" 

In the job-service terminal window, the output should be similar to the following:

ERRO[0568] Error getting job c-3po due to: rpc error: code = Unknown desc = job not found: c-3po instance=local scope=dapr.api type=log ver=1.15.0