OSIsoft Cloud Services (OCS) is a highly flexible cloud-based platform that provides scalable, elastic, centralized environment to aggregate data for reporting, advanced analytics, and third-party applications. OCS is powered by OSIsoft's Sequential Data Store (SDS). In this GitHub repo, we provide samples which will help you get started with the OCS API against your OCS instance.
There are three types of samples/apps in the repo:
-
Getting Started - OCS focused samples for a task, usually implemented as a simple console app. This also includes base libraries that may be used in other apps. -
Ingress apps - Real world examples of applications focused on sending data to OCS. -
End-End apps - Real world examples of web, desktop, mobile, and other applications using OCS data.
Some tasks and individual language examples may have some additional labels as follows:
-
* denotes that the language example uses the rest API directily instead of a library
-
This task and code uses services that are currently in preview. If you are interested in this functionality, please contact OCS support.
The official OCS samples are divided in multiple categories depending on the scenario and problem/task, accessible through the following table:
| Task | Description | Languages | Test Status |
|---|---|---|---|
Authentication  |
Client Credential Details Hybrid Authentication Details Implicit Authentication Details |
.NET .NET .NET and JavaScript |
|
| Types, Streams, and retreiving Data |
Covers typical operations against the Sds, including creating, updating, and deleting types, streams and events. This is the recommended starting example, and a good a base for all other Tasks. Details | .NET .NET* JAVA Angular nodeJS Python2 Python3 |
|
| Ingress Management |
Covers management operations for Ingress, including creating and deleting publishers, ingress tokens, topics, and subscriptions. | .NET | |
| UOM |
Covers the basic functionality of the UOM system on OCS | .NET | |
| OMF Messages |
These samples demonstrate sending some typical OMF messages. The applications are configurable to both PI and OCS. | .NET* Python3* |
|
| Sample Libraries |
These sample libraries are used as the base for the other samples. They are designed to be straightforward implementations of the REST APIs. They are for use in the samples. | Java Python3 |
|
 Dataviews |
These samples highlight basic operations of Dataviews for OCS, including creation, updating, getting data from and deletion of dataviews. Details | Java Python3 |
A credential config.ini or app.config file is used in the examples unless otherwise noted in the example.
Note: This is not a secure way to store credentials. This is to be used at your own risk.
You will need to modify these files locally when you run the samples.
Please raise an issue if you would like to see a new task, a new example inside of a task, or an existing example in a particular langauge.
If you wish to contribute please take a look at the contribution guide.
OCS Samples are licensed under the Apache 2 license.