Skip to content
.NET Library for Orchestrate
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.nuget
Orchestrate.Net.Tests
Orchestrate.Net
.gitattributes
.gitignore
Orchestrate.NET.1.0.0.0.nupkg
Orchestrate.NET.1.1.0.nupkg
Orchestrate.NET.1.1.1.nupkg
Orchestrate.NET.1.2.0.nupkg
Orchestrate.NET.1.2.1.nupkg
Orchestrate.NET.1.3.0.nupkg
Orchestrate.NET.2.0.0.nupkg
Orchestrate.Net.sln
README.md
license.txt

README.md

Orchestrate.NET

.NET Library for Orchestrate

Build status

Installation

PM> Install-Package Orchestrate.NET

Running Tests

Orchestrate.NET runs against the actual Orchestrate API. Go to Orchestrate.io and set up an account. Create a new application and use the API key provided.

Docs

Please refer to the docs at orchestrate.io for more details.

Creating a Client

var orchestrate = new Orchestrate.Net.Orchestrate(api key);

Creating a collection

Creating a collection requires an object to be placed in the collection. No empty collections allowed.

var collection = orchestrate.Put(collectionName, key, object);

or you can pass in a json string:

var collection = orchestrate.Put(collectionName, key, json);

Get

You can retrieve items by key with the Get method:

Result result = orchestrate.Get(collectionName, key);

var item = result.Value;

Post

You can add items to your collection with the Post command. This will add the item and generate a unique key:

Result result = orchestrate.Post(collectionName, object);

or use a json string:

Result result = orchestrate.Post(collectionName, json);

Put

You can add/update items to your collection via the Put method. This will not create a new key, but use the one provided:

Result result = orchestrate.Put(collectionName, key, object);

or you can pass in a json string:

var collection = orchestrate.Put(collectionName, key, json);

Search

Searching a collection is as simple as defining a Lucene query string. (http://lucene.apache.org/core/4_3_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Overview)

SearchResult result = orchestrate.Search(collectionName, query, limit, offset);

Lists, Refs, Events and Graphs

Are all supported, see the docs on the Orchestrate.io website for details.

Contributing

Building the source

For running tests follow either of the approaches

  • update the app.config file in the path Orchestrate.Net.Tests/ and replace YOUR-API-KEY-GOES-HERE with your api key (remember to unset this value before you commit/push your code to repository).

  • set the environment variable OrchestrateApiKey value to match your api key (if you set this after you have opened Visual Studio, please restart Visual Studio, otherwise the environment variable will not be available).

If both the above settings are set, then the value set in environment variable will be used.

You can’t perform that action at this time.