Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.7 KB

AssetTypeConfigsApi.md

File metadata and controls

63 lines (39 loc) · 1.7 KB
Raw

BlueprintClient::AssetTypeConfigsApi

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

Method HTTP request Description
get GET /{namespace}/assets/{assetType}/templates

get

TemplateBody get(namespace, asset_type, )

get a template for a given asset type

Example

# 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

Parameters

Name Type Description Notes
namespace 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 String subtype of Asset, e.g. 'textbooks', 'digitisations', etc.

Return type

TemplateBody

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.api+json