BlueprintClient - the Ruby gem for the Talis Blueprint API

This is the API documentation for Blueprint, a primitive for institutional structure and time periods

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 0.5.4
• Build date: 2017-04-21T08:35:10.351+01:00
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

To update the gem code to the latest API specification:

sh generate.sh

Customise the code generation by modifying the template files.

To build the Ruby code into a gem:

gem build blueprint_ruby_client.gemspec

Then either install the gem locally:

gem install ./blueprint_ruby_client-0.5.4.gem

(for development, run gem install --dev ./blueprint_ruby_client-0.5.4.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'blueprint_ruby_client', '~> 0.5.4'

If the Ruby gem is hosted at a git repository: https://github.com/talis/blueprint_rb, then add the following in the Gemfile:

gem 'blueprint_ruby_client', :git => 'https://github.com/talis/blueprint_rb.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'blueprint_ruby_client'

# Setup authorization
BlueprintClient.configure do |config|
  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = BlueprintClient::AssetTypeConfigsApi.new

namespace = "namespace_example" # String | identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.

asset_type = "asset_type_example" # String | subtype of Asset, e.g. 'textbooks', 'digitisations', etc.


begin
  result = api_instance.get(namespace, asset_type, )
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling AssetTypeConfigsApi->get: #{e}"
end

All URIs are relative to http://localhost:10010/1

• BlueprintClient::Asset
• BlueprintClient::AssetBody
• BlueprintClient::AssetRelationship
• BlueprintClient::AssetRelationships
• BlueprintClient::AssetResultSet
• BlueprintClient::Error
• BlueprintClient::Errors
• BlueprintClient::Integration
• BlueprintClient::IntegrationBody
• BlueprintClient::IntegrationTransform
• BlueprintClient::IntegrationTransformExample
• BlueprintClient::Links
• BlueprintClient::Lti1IntegrationAttributes
• BlueprintClient::Meta
• BlueprintClient::Namespace
• BlueprintClient::NamespaceRelationship
• BlueprintClient::Node
• BlueprintClient::NodeAttributes
• BlueprintClient::NodeBody
• BlueprintClient::NodeRelationship
• BlueprintClient::NodeRelationships
• BlueprintClient::NodeResultSet
• BlueprintClient::Resource
• BlueprintClient::Template
• BlueprintClient::TemplateAttributes
• BlueprintClient::TemplateBody
• BlueprintClient::TemplateVariables

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • su: Talis super user
  • su@{namespace}: Super user for a specific blueprint