Giter Club home page Giter Club logo

mschellenger96 / ocs-samples Goto Github PK

View Code? Open in Web Editor NEW

This project forked from aveva/aveva-samples

0.0 1.0 0.0 48.48 MB

The OSIsoft Cloud Services API samples are introductory, language-specific examples of programming against OCS. They are intended as instructional samples only.

Home Page: https://cloud.osisoft.com/samples

License: Apache License 2.0

C# 2.80% Python 5.33% JavaScript 86.50% HTML 0.31% Java 3.00% TypeScript 2.03% CSS 0.03%

ocs-samples's Introduction

OCS Samples

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 icon 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 icon Ingress apps - Real world examples of applications focused on sending data to OCS.

  • e2e icon 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

  • ctp icon 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       
Client Credential Authentication getting-started icon Covers the client credential flow of authentication against OCS. Click here For more Details on the various credential patterns. .NET
Hybrid Authentication getting-started icon Covers the hybrid flow of authentication against OCS. Click here For more Details on the various credential patterns. .NET
Implicit Authentication getting-started icon Covers the implicit flow of authentication against OCS. Click here For more Details on the various credential patterns. .NET and JavaScript
SDS Application getting-started icon 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


Build Status



Build Status
Ingress Management getting-started icon Covers management operations for Ingress, including creating and deleting publishers, ingress tokens, topics, and subscriptions. .NET   
UOM getting-started icon Covers the basic functionality of the UOM system on OCS .NET   
Sample Libraries getting-started icon 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
ctp icon Dataviews getting-started icon These samples highlight basic operations of Dataviews for OCS, including creation, updating, getting data from and deletion of dataviews. Details Java
Python3
Build Status
Build Status

Credentials

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.

Request for example

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.

Contributions

If you wish to contribute please take a look at the contribution guide.

License

OCS Samples are licensed under the Apache 2 license.

ocs-samples's People

Contributors

bderveni avatar cfoisy-osisoft avatar chad-at-osisoft avatar davidpatosisoft avatar derekendres avatar egove avatar freejules avatar gdinak avatar geetikasharma26 avatar gleeosi avatar gregoryholt avatar gthuruv avatar jakemessner avatar jgolla avatar kanepenley avatar lbakerosisoft avatar manastalukdar avatar mckenzielee avatar mindystivers avatar osi-writer avatar pirogovsky avatar rahul10992 avatar robertbeeson avatar rshankar1 avatar sagarwal29 avatar sairoop23 avatar slidell4life avatar sukhdev1103 avatar tomseymour avatar vbiala avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.