LINQ to JobNimbus Data

This article illustrates using LINQ to access tables within the JobNimbus via the CData ADO.NET Data Provider for JobNimbus. To achieve this, we will use LINQ to Entity Framework, which facilitates the generation of connections and can be seamlessly employed with any CData ADO.NET Data Providers to access data through LINQ.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

1. In a new project in Visual Studio, right-click on the project and choose to add a new item. Add an ADO.NET Entity Data Model.
2. Choose EF Designer from Database and click Next.
3. Add a new Data Connection, and change your data source type to "CData JobNimbus Data Source".

4. Enter your data source connection information.

   Using API Key Authentication

   JobNimbus uses API key authentication to control access to the API. To obtain a JobNimbus API key:

   1. Log in to your JobNimbus account.
   2. Navigate to Settings > Integrations > API.
   3. Generate or copy your existing API key from this page.

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   Set the following in the ProfileSettings connection property:
   • APIKey: Set this to your JobNimbus API key.

   Example Connection String

   Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';
   

   Below is a typical connection string:

   Profile=C:\profiles\JobNimbus.apip;AuthScheme=APIKey;ProfileSettings='APIKey=my_api_key';


5. If saving your entity connection to App.Config, set an entity name. In this example we are setting APIEntities as our entity connection in App.Config.
6. Enter a model name and select any tables or views you would like to include in the model.

Using the entity you created, you can now perform select commands. For example:

APIEntities context = new APIEntities();

var accountusersQuery = from accountusers in context.AccountUsers
  select accountusers;

foreach (var result in accountusersQuery) {
  Console.WriteLine("{0} {1} ", result.Id, result.);
}

See "LINQ and Entity Framework" chapter in the help documentation for example queries of the supported LINQ.