Examples

Creating a job

Here is a simple application that creates or updates a job through the import endpoint. A job in Dime.Scheduler is the equivalent of an order (service, sales, project, production, etc.) in the real world.

The import endpoint is arguably the most important element in the entire SDK. It's the entry point to push data into Dime.Scheduler. Through a single interface, you can manage pretty much all the data that is used in the planning tool.

See the inline comments for the steps required to complete a request successfully.

C#
JavaScript

public class Program
{
  public static async Task Main(string[] args)
  {
    Console.WriteLine("Adding/updating a job to Dime.Scheduler");

    // Step #1 is to define the variables
    const string uri = "https://my-dimescheduler-uri";
    IAuthenticator authenticator = new FormsAuthenticator(
        uri,
        "dsserviceaccount@mycustomer.com",
        "My$trongP@$$w0rd"
    );

    // Step #2 is to instantiate and create an authenticated endpoint
    DimeSchedulerClient client = new(uri, authenticator);
    IImportEndpoint importEndpoint = await client.Import.Request();

    // Step #3 is to actually make and send the request
    Job order = new()
    {
        SourceApp = "MY APPLICATION",
        SourceType = "SERVICE_ORDER_0001",
        JobNo = "CUSTOMER_XYZ_REPAIRCODE_012",
        ShortDescription = "Repair HVAC Customer XYZ"
    };

    await importEndpoint.ProcessAsync(order, TransactionType.Append);

    Console.ReadLine();
  }
}

import { DimeSchedulerClient, FormsAuthenticator, Import } from 'dimescheduler';

var uri = 'https://my-dimescheduler.uri';
var user = 'admin@my-dimescheduler.uri';
var pw = "mypassword";

var authn = new FormsAuthenticator(uri, user, pw);
var client = new DimeSchedulerClient(uri, authn);

var category = new Import.Category();
category.name = "New category";
category.color = '#000000';

client.import
  .processAsync(category)
  .then((res) => {
    console.log(res.data.Success? 'Success!' : "Oh oh, something didn't quite go well.";);
  })
  .catch((err) => console.log('Something went wrong: ' + err.toString()));

This will have inserted a job into Dime.Scheduler. The next step then would be to insert a task. You may reuse the instance of the import service:

// Step #4: add additional data
Task jobTask = new()
{
    SourceApp = "MY APPLICATION",
    SourceType = "SERVICE_ORDER_0001",
    JobNo = "CUSTOMER_XYZ_REPAIRCODE_012",
    TaskNo = "Repair HVAC machine code 9900109 in storage room X",
    ShortDescription = "Repair HVAC Customer XYZ"
};

await importEndpoint.ProcessAsync(jobTask, TransactionType.Append);

More examples can be found on Github.

Interactive example

Or run the following interactive example:

Creating a job​

Interactive example​

Creating a job

Interactive example