Search code, repositories, users, issues, pull requests...

Authorization

HTTP request headers

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

bulk_upload

bulk_upload(namespace, )

Send operations to modify nodes in bulk, to be applied/rejected as a single transaction.\nFormat will be:\n\n OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n

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::HierarchyApi.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.


begin
  api_instance.bulk_upload(namespace, )
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->bulk_upload: #{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.

Return type

nil (empty response body)

Authorization

HTTP request headers

Content-Type: text/plain, application/octet-stream
Accept: application/vnd.api+json

delete_node

delete_node(namespace, id, type)

Delete a node

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::HierarchyApi.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.

id = "id_example" # String | id identifying a domain model

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.


begin
  api_instance.delete_node(namespace, id, type)
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->delete_node: #{e}"
end

Parameters

Name	Type	Description
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
id	String	id identifying a domain model
type	String	subtype of Node, e.g. 'modules', 'departments', etc.

Return type

nil (empty response body)

Authorization

HTTP request headers

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

delete_nodes

delete_nodes(namespace_inc_global)

Delete nodes

Delete all nodes belonging to the given namespace.

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::HierarchyApi.new

namespace_inc_global = "namespace_inc_global_example" # String | identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.


begin
  #Delete nodes
  api_instance.delete_nodes(namespace_inc_global)
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->delete_nodes: #{e}"
end

Parameters

Name	Type	Description	Notes
namespace_inc_global	String	identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.

Return type

nil (empty response body)

Authorization

HTTP request headers

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

export_hierarchy

export_hierarchy(namespace, )

Download the blueprint's nodes in CSV format\nFormat will be:\n\n OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n\nOLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer\n

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::HierarchyApi.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.


begin
  api_instance.export_hierarchy(namespace, )
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->export_hierarchy: #{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.

Return type

nil (empty response body)

Authorization

HTTP request headers

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

get_ancestors

NodeResultSet get_ancestors(id, namespace, type, opts)

Get ancestor nodes

A proxy for finding ancestors of a given node, equivalent to\n/1/abc/nodes?filter[descendant]=department%2Fdep101\n

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::HierarchyApi.new

id = "id_example" # String | id identifying a domain model

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.

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.

opts = { 
  offset: 3.4, # Float | index to start result set from
  limit: 3.4 # Float | number of records to return
}

begin
  #Get ancestor nodes
  result = api_instance.get_ancestors(id, namespace, type, opts)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->get_ancestors: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	id identifying a domain model
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
type	String	subtype of Node, e.g. 'modules', 'departments', etc.
offset	Float	index to start result set from	[optional]
limit	Float	number of records to return	[optional]

Return type

Authorization

HTTP request headers

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

get_children

NodeResultSet get_children(id, namespace, type, opts)

Get child nodes

A proxy for finding children of a given node, equivalent to\n/1/abc/nodes?filter[parent]=department%2Fdep101\n

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::HierarchyApi.new

id = "id_example" # String | id identifying a domain model

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.

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.

opts = { 
  offset: 3.4, # Float | index to start result set from
  limit: 3.4 # Float | number of records to return
}

begin
  #Get child nodes
  result = api_instance.get_children(id, namespace, type, opts)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->get_children: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	id identifying a domain model
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
type	String	subtype of Node, e.g. 'modules', 'departments', etc.
offset	Float	index to start result set from	[optional]
limit	Float	number of records to return	[optional]

Return type

Authorization

HTTP request headers

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

get_descendants

NodeResultSet get_descendants(id, namespace, type, opts)

Get descendant nodes

A proxy for finding descendants of a given node, equivalent to\n/1/abc/nodes?filter[ancestor]=department%2Fdep101\n

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::HierarchyApi.new

id = "id_example" # String | id identifying a domain model

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.

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.

opts = { 
  offset: 3.4, # Float | index to start result set from
  limit: 3.4 # Float | number of records to return
}

begin
  #Get descendant nodes
  result = api_instance.get_descendants(id, namespace, type, opts)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->get_descendants: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	id identifying a domain model
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
type	String	subtype of Node, e.g. 'modules', 'departments', etc.
offset	Float	index to start result set from	[optional]
limit	Float	number of records to return	[optional]

Return type

Authorization

HTTP request headers

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

get_node

NodeBody get_node(namespace, id, type, opts)

Get details of a given node

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::HierarchyApi.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.

id = "id_example" # String | id identifying a domain model

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.

opts = { 
  include: ["include_example"] # Array<String> | comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets
}

begin
  #
  result = api_instance.get_node(namespace, id, type, opts)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->get_node: #{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.
id	String	id identifying a domain model
type	String	subtype of Node, e.g. 'modules', 'departments', etc.
include	Array<String>	comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets	[optional]

Return type

Authorization

HTTP request headers

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

get_parents

NodeResultSet get_parents(id, namespace, type, opts)

Get parent nodes

A proxy for finding parents of a given node, equivalent to\n/1/abc/nodes?filter[child]=department%2Fdep101\n

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::HierarchyApi.new

id = "id_example" # String | id identifying a domain model

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.

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.

opts = { 
  offset: 3.4, # Float | index to start result set from
  limit: 3.4 # Float | number of records to return
}

begin
  #Get parent nodes
  result = api_instance.get_parents(id, namespace, type, opts)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->get_parents: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	id identifying a domain model
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
type	String	subtype of Node, e.g. 'modules', 'departments', etc.
offset	Float	index to start result set from	[optional]
limit	Float	number of records to return	[optional]

Return type

Authorization

HTTP request headers

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

replace_node

NodeBody replace_node(namespace, id, body, type)

Replaces the node with the data sent in the body

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::HierarchyApi.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.

id = "id_example" # String | id identifying a domain model

body = BlueprintClient::NodeBody.new # NodeBody | node

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.


begin
  #
  result = api_instance.replace_node(namespace, id, body, type)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->replace_node: #{e}"
end

Parameters

Name	Type	Description
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
id	String	id identifying a domain model
body	NodeBody	node
type	String	subtype of Node, e.g. 'modules', 'departments', etc.

Return type

Authorization

HTTP request headers

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

search_nodes

NodeResultSet search_nodes(namespace_inc_global, opts)

Search nodes

This endpoint is a really flexible way to ask questions about the hierarchy.\nThe includes parameter can be set to either parents, children, assets.\n\nExamples:\n\n###### Find all nodes for abc:\n/1/abc/nodes\n\n###### Find all modules for abc:\n/1/abc/nodes?filter[nodeType]=Modules\n\n###### Find all nodes that are descendants of DEP101:\n/1/abc/nodes?filter[descendant]=departments%2Fdep101\n\n###### Find all nodes that are descendants of DEP101 or DEP102:\n/1/abc/nodes?filter[descendant]=departments%2Fdep101,departments%2Fdep102\n\n###### Find all nodes that are descendants of DEP101 and DEP102:\n/1/abc/nodes?filter[descendant]=departments%2Fdep101&filter[descendant]=departments%2Fdep102``\n\n###### Find all Departments that are ancestors of ABF203:\n/1/abc/nodes?filter[descendant]=modules%2Fabf203&filter[nodeType]=Departments # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n/1/abc/nodes?filter[nodeType]=Modules&filter[ancestor]=departments%2FDEP101&filter[hasAssets]=true&filter[assetType]=Lists\n\n###### Globally, find all modules that have no list assets\n/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[assetType]=Lists\n\n###### Find all nodes of type modules during 2015 that have no assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify\n/1/global/nodes?filter[nodeType]=Modules&filter[hasAssets]=false&filter[from]=20150101&filter[to]=20151231\n\n###### Find all nodes of type modules with assets which are also related to DEP101.\n/1/global/nodes?filter[nodeType]=Modules&filter[asset.node]=departments%2Fdep101`\n

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::HierarchyApi.new

namespace_inc_global = "namespace_inc_global_example" # String | identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.

opts = { 
  offset: 3.4, # Float | index to start result set from
  limit: 3.4 # Float | number of records to return
  include: ["include_example"] # Array<String> | comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets
  filter_asset: ["filter_asset_example"], # Array<String> | limit to nodes that have an asset matching type/code
  filter_node_type: ["filter_node_type_example"], # Array<String> | type of nodes to return
  filter_child: ["filter_child_example"], # Array<String> | limit to nodes with children matching type/code
  filter_parent: ["filter_parent_example"], # Array<String> | limit to nodes with parent matching type/code
  filter_ancestor: ["filter_ancestor_example"], # Array<String> | limit to nodes with ancestor matching type/code
  filter_descendant: ["filter_descendant_example"], # Array<String> | limit to nodes with descendant matching type/code
  filter_has_assets: true, # BOOLEAN | limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets
  filter_asset_type: ["filter_asset_type_example"], # Array<String> | type of asset to return. This filters the results by asset type, but returns all the assets associated with the result.
  filter_from: Date.parse("2013-10-20"), # Date | limit to results valid after this date, format is  ISO8601 date
  filter_to: Date.parse("2013-10-20"), # Date | limit to results valid before this date, format is  ISO8601
  q_node: "q_node_example", # String | query term(s) to search for nodes.  Allows wildcard searching with '*'
  q_child: "q_child_example", # String | query id/title terms to search for child nodes.  Allows wildcard searching with '*'
  q_parent: "q_parent_example", # String | query id/title terms to search for parent nodes.  Allows wildcard searching with '*'
  q_descendant: "q_descendant_example", # String | query id/title terms to search for descendant nodes.  Allows wildcard searching with '*'
  q_ancestor: "q_ancestor_example", # String | query id/title terms to search for ancestor nodes.  Allows wildcard searching with '*'
  filter_asset_node: ["filter_asset_node_example"] # Array<String> | limit to nodes that have an asset related to another node matching type/code
}

begin
  #Search nodes
  result = api_instance.search_nodes(namespace_inc_global, opts)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->search_nodes: #{e}"
end

Parameters

Name	Type	Description	Notes
namespace_inc_global	String	identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
offset	Float	index to start result set from	[optional]
limit	Float	number of records to return	[optional]
include	Array<String>	comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets	[optional]
filter_asset	Array<String>	limit to nodes that have an asset matching type/code	[optional]
filter_node_type	Array<String>	type of nodes to return	[optional]
filter_child	Array<String>	limit to nodes with children matching type/code	[optional]
filter_parent	Array<String>	limit to nodes with parent matching type/code	[optional]
filter_ancestor	Array<String>	limit to nodes with ancestor matching type/code	[optional]
filter_descendant	Array<String>	limit to nodes with descendant matching type/code	[optional]
filter_has_assets	BOOLEAN	limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets	[optional]
filter_asset_type	Array<String>	type of asset to return. This filters the results by asset type, but returns all the assets associated with the result.	[optional]
filter_from	Date	limit to results valid after this date, format is ISO8601 date	[optional]
filter_to	Date	limit to results valid before this date, format is ISO8601	[optional]
q_node	String	query term(s) to search for nodes. Allows wildcard searching with '*'	[optional]
q_child	String	query id/title terms to search for child nodes. Allows wildcard searching with '*'	[optional]
q_parent	String	query id/title terms to search for parent nodes. Allows wildcard searching with '*'	[optional]
q_descendant	String	query id/title terms to search for descendant nodes. Allows wildcard searching with '*'	[optional]
q_ancestor	String	query id/title terms to search for ancestor nodes. Allows wildcard searching with '*'	[optional]
filter_asset_node	Array<String>	limit to nodes that have an asset related to another node matching type/code	[optional]

Return type

Authorization

HTTP request headers

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

update_node

NodeBody update_node(namespace, id, body, type)

Perform a partial update of a node

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::HierarchyApi.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.

id = "id_example" # String | id identifying a domain model

body = BlueprintClient::NodeBody.new # NodeBody | node

type = "type_example" # String | subtype of Node, e.g. 'modules', 'departments', etc.


begin
  result = api_instance.update_node(namespace, id, body, type)
  p result
rescue BlueprintClient::ApiError => e
  puts "Exception when calling HierarchyApi->update_node: #{e}"
end

Parameters

Name	Type	Description
namespace	String	identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
id	String	id identifying a domain model
body	NodeBody	node
type	String	subtype of Node, e.g. 'modules', 'departments', etc.

Return type

Authorization