Our .net Software Development Kit (SDK) is an interface to the OpenGround API that allows your applications to interact with the OpenGround platform.
It offers capabilities to programmatically perform querying, data manipulation, report generation, data transfer and configuration recall.
This reference guide details the relevant development concepts to help you get started with the SDK.
To obtain the SDK & Code Examples, please contact support.
Please also see this guide for general information on Getting Started with the OpenGround API.
Prior to commencing development with the SDK, the following will be required:
Nuget packages are available for .net Standard v1.4, Framework v4.5 and v4.72. To obtain these and the code examples, please contact support.
Please see the Getting Started with the OpenGround API guide for more information about authentication, requesting a Client ID/Secret, obtaining your Instance ID/Region, and other topics.
All SDK example methods are located in the Bentley.OpenGround.DeveloperNetwork.Examples project’s Program.cs.
These examples demonstrate how to use the SDK to perform functions within OpenGround. Where applicable, comments exist to explain how various operations are performed.
All examples assume you have valid credentials and the appropriate permissions.
Before running the samples, the following connection constants need to be configured in Program.cs inside the Connection Configuration region.
The methods below can be invoked from Main().
Please see this video for more information:
| Region | Function | Method |
| Authentication | Perform machine authentication (automated) | PerformMachineLogin |
| Perform user authentication (interactive) | PerformUserLogin | |
| Monitor authentication events | ConfigureAuthenticationEvents | |
| Perform logout | Logout | |
| Projects | Recall projects available to the user | GetProjects |
| Create a new project | CreateProject | |
| Data Model | Recall groups and headers within a configuration pack | GetConfigurationDataModel |
| Recall groups and headers within a project | GetProjectDataModel | |
| Documents | Download borehole log template | DownloadDocument |
| Data Querying | Perform query with filtering | QueryProject |
| Templates | Determine available report templates within a configuration pack | GetConfigurationTemplates |
| Determine available report templates within a project | GetProjectTemplates | |
| Configuration | Retrieve system-level picklist groups and values | GetSystemPicklistValues |
| Retrieve project-level picklist groups and values | GetProjectPicklistValues | |
| Borehole Log | Generate borehole log | CreateQuickLog |
| Log Report | Generate log report | CreateLogReport |
| Section Log | Generate section report | CreateSectionLog |
| Data Transfer | Obtain transfer mappings for imports and exports | GetTransferMappings |
| Import AGS data | ImportAgs | |
| Import CSV data | ImportCsv | |
| Export AGS data | ExportAgs | |
| Export CSV data | ExportCsv |