blueprint_ruby_client 0.5.2 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/config.json +1 -1
- data/docs/AssetTypeConfigsApi.md +2 -2
- data/docs/AssetTypeTemplatesApi.md +6 -6
- data/docs/AssetsApi.md +18 -18
- data/docs/HierarchyApi.md +25 -23
- data/docs/IntegrationsApi.md +10 -10
- data/docs/LTIApi.md +2 -2
- data/generate.sh +0 -0
- data/lib/blueprint_ruby_client/api/asset_type_configs_api.rb +2 -2
- data/lib/blueprint_ruby_client/api/asset_type_templates_api.rb +6 -6
- data/lib/blueprint_ruby_client/api/assets_api.rb +18 -18
- data/lib/blueprint_ruby_client/api/hierarchy_api.rb +33 -24
- data/lib/blueprint_ruby_client/api/integrations_api.rb +10 -10
- data/lib/blueprint_ruby_client/api/lti_api.rb +2 -2
- data/lib/blueprint_ruby_client/version.rb +1 -1
- data/spec/api/asset_type_configs_api_spec.rb +1 -1
- data/spec/api/asset_type_templates_api_spec.rb +3 -3
- data/spec/api/assets_api_spec.rb +9 -9
- data/spec/api/hierarchy_api_spec.rb +13 -12
- data/spec/api/integrations_api_spec.rb +5 -5
- data/spec/api/lti_api_spec.rb +1 -1
- metadata +21 -24
- data/Gemfile.lock +0 -65
- data/blueprint_ruby_client-0.5.1.gem +0 -0
data/docs/IntegrationsApi.md
CHANGED
@@ -30,7 +30,7 @@ end
|
|
30
30
|
|
31
31
|
api_instance = BlueprintClient::IntegrationsApi.new
|
32
32
|
|
33
|
-
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
33
|
+
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.
|
34
34
|
|
35
35
|
body = BlueprintClient::IntegrationBody.new # IntegrationBody | integration
|
36
36
|
|
@@ -47,7 +47,7 @@ end
|
|
47
47
|
|
48
48
|
Name | Type | Description | Notes
|
49
49
|
------------- | ------------- | ------------- | -------------
|
50
|
-
**namespace** | **String**| identifier namespacing the blueprint. |
|
50
|
+
**namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
|
51
51
|
**body** | [**IntegrationBody**](IntegrationBody.md)| integration |
|
52
52
|
|
53
53
|
### Return type
|
@@ -84,7 +84,7 @@ end
|
|
84
84
|
|
85
85
|
api_instance = BlueprintClient::IntegrationsApi.new
|
86
86
|
|
87
|
-
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
87
|
+
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.
|
88
88
|
|
89
89
|
integration_id = "integration_id_example" # String | id of an integration
|
90
90
|
|
@@ -102,7 +102,7 @@ end
|
|
102
102
|
|
103
103
|
Name | Type | Description | Notes
|
104
104
|
------------- | ------------- | ------------- | -------------
|
105
|
-
**namespace** | **String**| identifier namespacing the blueprint. |
|
105
|
+
**namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
|
106
106
|
**integration_id** | **String**| id of an integration |
|
107
107
|
**integration_type** | **String**| Type of external integration, e.g. 'lti1' |
|
108
108
|
|
@@ -140,7 +140,7 @@ end
|
|
140
140
|
|
141
141
|
api_instance = BlueprintClient::IntegrationsApi.new
|
142
142
|
|
143
|
-
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
143
|
+
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.
|
144
144
|
|
145
145
|
integration_type = "integration_type_example" # String | Type of external integration, e.g. 'lti1'
|
146
146
|
|
@@ -159,7 +159,7 @@ end
|
|
159
159
|
|
160
160
|
Name | Type | Description | Notes
|
161
161
|
------------- | ------------- | ------------- | -------------
|
162
|
-
**namespace** | **String**| identifier namespacing the blueprint. |
|
162
|
+
**namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
|
163
163
|
**integration_type** | **String**| Type of external integration, e.g. 'lti1' |
|
164
164
|
**integration_id** | **String**| id of an integration |
|
165
165
|
|
@@ -192,7 +192,7 @@ require 'blueprint_ruby_client'
|
|
192
192
|
|
193
193
|
api_instance = BlueprintClient::IntegrationsApi.new
|
194
194
|
|
195
|
-
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
195
|
+
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.
|
196
196
|
|
197
197
|
integration_id = "integration_id_example" # String | id of an integration
|
198
198
|
|
@@ -232,7 +232,7 @@ end
|
|
232
232
|
|
233
233
|
Name | Type | Description | Notes
|
234
234
|
------------- | ------------- | ------------- | -------------
|
235
|
-
**namespace** | **String**| identifier namespacing the blueprint. |
|
235
|
+
**namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
|
236
236
|
**integration_id** | **String**| id of an integration |
|
237
237
|
**asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
|
238
238
|
**asset_id** | **String**| id of an asset |
|
@@ -286,7 +286,7 @@ end
|
|
286
286
|
|
287
287
|
api_instance = BlueprintClient::IntegrationsApi.new
|
288
288
|
|
289
|
-
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
289
|
+
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.
|
290
290
|
|
291
291
|
integration_id = "integration_id_example" # String | id of an integration
|
292
292
|
|
@@ -307,7 +307,7 @@ end
|
|
307
307
|
|
308
308
|
Name | Type | Description | Notes
|
309
309
|
------------- | ------------- | ------------- | -------------
|
310
|
-
**namespace** | **String**| identifier namespacing the blueprint. |
|
310
|
+
**namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
|
311
311
|
**integration_id** | **String**| id of an integration |
|
312
312
|
**integration_type** | **String**| Type of external integration, e.g. 'lti1' |
|
313
313
|
**body** | [**IntegrationBody**](IntegrationBody.md)| integration |
|
data/docs/LTIApi.md
CHANGED
@@ -21,7 +21,7 @@ require 'blueprint_ruby_client'
|
|
21
21
|
|
22
22
|
api_instance = BlueprintClient::LTIApi.new
|
23
23
|
|
24
|
-
namespace = "namespace_example" # String | identifier namespacing the blueprint.
|
24
|
+
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.
|
25
25
|
|
26
26
|
integration_id = "integration_id_example" # String | id of an integration
|
27
27
|
|
@@ -61,7 +61,7 @@ end
|
|
61
61
|
|
62
62
|
Name | Type | Description | Notes
|
63
63
|
------------- | ------------- | ------------- | -------------
|
64
|
-
**namespace** | **String**| identifier namespacing the blueprint. |
|
64
|
+
**namespace** | **String**| identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores. |
|
65
65
|
**integration_id** | **String**| id of an integration |
|
66
66
|
**asset_type** | **String**| subtype of Asset, e.g. 'textbooks', 'digitisations', etc. |
|
67
67
|
**asset_id** | **String**| id of an asset |
|
data/generate.sh
CHANGED
File without changes
|
@@ -22,7 +22,7 @@ module BlueprintClient
|
|
22
22
|
|
23
23
|
#
|
24
24
|
# get a template for a given asset type
|
25
|
-
# @param namespace identifier namespacing the blueprint.
|
25
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
26
26
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
27
27
|
# @param [Hash] opts the optional parameters
|
28
28
|
# @return [TemplateBody]
|
@@ -33,7 +33,7 @@ module BlueprintClient
|
|
33
33
|
|
34
34
|
#
|
35
35
|
# get a template for a given asset type
|
36
|
-
# @param namespace identifier namespacing the blueprint.
|
36
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
37
37
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @return [Array<(TemplateBody, Fixnum, Hash)>] TemplateBody data, response status code and response headers
|
@@ -22,7 +22,7 @@ module BlueprintClient
|
|
22
22
|
|
23
23
|
#
|
24
24
|
# Configure a template for a given asset type
|
25
|
-
# @param namespace identifier namespacing the blueprint.
|
25
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
26
26
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
27
27
|
# @param template_body template body
|
28
28
|
# @param [Hash] opts the optional parameters
|
@@ -34,7 +34,7 @@ module BlueprintClient
|
|
34
34
|
|
35
35
|
#
|
36
36
|
# Configure a template for a given asset type
|
37
|
-
# @param namespace identifier namespacing the blueprint.
|
37
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
38
38
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
39
39
|
# @param template_body template body
|
40
40
|
# @param [Hash] opts the optional parameters
|
@@ -107,7 +107,7 @@ module BlueprintClient
|
|
107
107
|
|
108
108
|
#
|
109
109
|
# Delete a template for a given asset type
|
110
|
-
# @param namespace identifier namespacing the blueprint.
|
110
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
111
111
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
112
112
|
# @param [Hash] opts the optional parameters
|
113
113
|
# @return [TemplateBody]
|
@@ -118,7 +118,7 @@ module BlueprintClient
|
|
118
118
|
|
119
119
|
#
|
120
120
|
# Delete a template for a given asset type
|
121
|
-
# @param namespace identifier namespacing the blueprint.
|
121
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
122
122
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
123
123
|
# @param [Hash] opts the optional parameters
|
124
124
|
# @return [Array<(TemplateBody, Fixnum, Hash)>] TemplateBody data, response status code and response headers
|
@@ -182,7 +182,7 @@ module BlueprintClient
|
|
182
182
|
|
183
183
|
#
|
184
184
|
# update a template for a given asset type
|
185
|
-
# @param namespace identifier namespacing the blueprint.
|
185
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
186
186
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
187
187
|
# @param template_body template body
|
188
188
|
# @param [Hash] opts the optional parameters
|
@@ -194,7 +194,7 @@ module BlueprintClient
|
|
194
194
|
|
195
195
|
#
|
196
196
|
# update a template for a given asset type
|
197
|
-
# @param namespace identifier namespacing the blueprint.
|
197
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
198
198
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
199
199
|
# @param template_body template body
|
200
200
|
# @param [Hash] opts the optional parameters
|
@@ -22,7 +22,7 @@ module BlueprintClient
|
|
22
22
|
|
23
23
|
#
|
24
24
|
# Add an asset to the node. Body must be empty. Will upsert the asset if it doesn't exist
|
25
|
-
# @param namespace identifier namespacing the blueprint.
|
25
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
26
26
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
27
27
|
# @param id id identifying a domain model
|
28
28
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
@@ -36,7 +36,7 @@ module BlueprintClient
|
|
36
36
|
|
37
37
|
#
|
38
38
|
# Add an asset to the node. Body must be empty. Will upsert the asset if it doesn't exist
|
39
|
-
# @param namespace identifier namespacing the blueprint.
|
39
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
40
40
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
41
41
|
# @param id id identifying a domain model
|
42
42
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
@@ -127,7 +127,7 @@ module BlueprintClient
|
|
127
127
|
|
128
128
|
#
|
129
129
|
# Delete an Asset
|
130
|
-
# @param namespace identifier namespacing the blueprint.
|
130
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
131
131
|
# @param asset_id id of an asset
|
132
132
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
133
133
|
# @param [Hash] opts the optional parameters
|
@@ -139,7 +139,7 @@ module BlueprintClient
|
|
139
139
|
|
140
140
|
#
|
141
141
|
# Delete an Asset
|
142
|
-
# @param namespace identifier namespacing the blueprint.
|
142
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
143
143
|
# @param asset_id id of an asset
|
144
144
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
145
145
|
# @param [Hash] opts the optional parameters
|
@@ -211,7 +211,7 @@ module BlueprintClient
|
|
211
211
|
|
212
212
|
#
|
213
213
|
# Get details of a given asset
|
214
|
-
# @param namespace identifier namespacing the blueprint.
|
214
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
215
215
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
216
216
|
# @param asset_id id of an asset
|
217
217
|
# @param [Hash] opts the optional parameters
|
@@ -223,7 +223,7 @@ module BlueprintClient
|
|
223
223
|
|
224
224
|
#
|
225
225
|
# Get details of a given asset
|
226
|
-
# @param namespace identifier namespacing the blueprint.
|
226
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
227
227
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
228
228
|
# @param asset_id id of an asset
|
229
229
|
# @param [Hash] opts the optional parameters
|
@@ -296,11 +296,11 @@ module BlueprintClient
|
|
296
296
|
|
297
297
|
#
|
298
298
|
# Get for assets in the relevant node
|
299
|
-
# @param namespace identifier namespacing the blueprint.
|
299
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
300
300
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
301
301
|
# @param id id identifying a domain model
|
302
302
|
# @param [Hash] opts the optional parameters
|
303
|
-
# @option opts [Array<String>] :filter_asset_type type of asset to return
|
303
|
+
# @option opts [Array<String>] :filter_asset_type type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
|
304
304
|
# @option opts [Float] :offset index to start result set from
|
305
305
|
# @option opts [Float] :limit number of records to return
|
306
306
|
# @return [AssetResultSet]
|
@@ -311,11 +311,11 @@ module BlueprintClient
|
|
311
311
|
|
312
312
|
#
|
313
313
|
# Get for assets in the relevant node
|
314
|
-
# @param namespace identifier namespacing the blueprint.
|
314
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
315
315
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
316
316
|
# @param id id identifying a domain model
|
317
317
|
# @param [Hash] opts the optional parameters
|
318
|
-
# @option opts [Array<String>] :filter_asset_type type of asset to return
|
318
|
+
# @option opts [Array<String>] :filter_asset_type type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
|
319
319
|
# @option opts [Float] :offset index to start result set from
|
320
320
|
# @option opts [Float] :limit number of records to return
|
321
321
|
# @return [Array<(AssetResultSet, Fixnum, Hash)>] AssetResultSet data, response status code and response headers
|
@@ -408,7 +408,7 @@ module BlueprintClient
|
|
408
408
|
|
409
409
|
#
|
410
410
|
# Remove an asset from the relevant node
|
411
|
-
# @param namespace identifier namespacing the blueprint.
|
411
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
412
412
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
413
413
|
# @param id id identifying a domain model
|
414
414
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
@@ -422,7 +422,7 @@ module BlueprintClient
|
|
422
422
|
|
423
423
|
#
|
424
424
|
# Remove an asset from the relevant node
|
425
|
-
# @param namespace identifier namespacing the blueprint.
|
425
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
426
426
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
427
427
|
# @param id id identifying a domain model
|
428
428
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
@@ -512,7 +512,7 @@ module BlueprintClient
|
|
512
512
|
|
513
513
|
# Replaces the Asset with the data sent in the body
|
514
514
|
# Wholesale replacement of Asset data: if you were to PUT to:\n /1/{namespace}/assets/sometype/someid\n\nwith a body of:\n { type: \"someothertype\", id: \"someotherid\" }\n\nIt would change the Asset's path to:\n /1/{namespace}/assets/someothertype/someotherid\n\nand\n /1/{namespace}/assets/sometype/someid\nwould return a 404.\nIt would also update the assets associated with any node.\n
|
515
|
-
# @param namespace identifier namespacing the blueprint.
|
515
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
516
516
|
# @param asset_id id of an asset
|
517
517
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
518
518
|
# @param [Hash] opts the optional parameters
|
@@ -525,7 +525,7 @@ module BlueprintClient
|
|
525
525
|
|
526
526
|
# Replaces the Asset with the data sent in the body
|
527
527
|
# Wholesale replacement of Asset data: if you were to PUT to:\n /1/{namespace}/assets/sometype/someid\n\nwith a body of:\n { type: \"someothertype\", id: \"someotherid\" }\n\nIt would change the Asset's path to:\n /1/{namespace}/assets/someothertype/someotherid\n\nand\n /1/{namespace}/assets/sometype/someid\nwould return a 404.\nIt would also update the assets associated with any node.\n
|
528
|
-
# @param namespace identifier namespacing the blueprint.
|
528
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
529
529
|
# @param asset_id id of an asset
|
530
530
|
# @param asset_type subtype of Asset, e.g. 'textbooks', 'digitisations', etc.
|
531
531
|
# @param [Hash] opts the optional parameters
|
@@ -605,13 +605,13 @@ module BlueprintClient
|
|
605
605
|
|
606
606
|
# Search assets
|
607
607
|
# This endpoint provides a way to get assets as a pageable result set, based (optionally) on filters.\nThe include parameter can only be set to `nodes`\n\n###### Find all assets in namespace abc\n`/1/abc/assets`\n\n###### Find all lists for abc:\n`/1/abc/assets?filter[assetType]=lists`\n\n###### Find all assets that are related to a given node of DEP101:\n`/1/abc/assets?filter[node]=departments%2Fdep101`\n\n###### Find all assets that are related to both node DEP101 and DEP102:\n`/1/abc/assets?filter[node]=departments%2Fdep101&filter[node]=departments%2Fdep102`\n\n###### Find all assets that are related to either node DEP101 and DEP102:\n`/1/abc/assets?filter[node]=departments%2Fdep101,departments%2Fdep102`\n
|
608
|
-
# @param namespace identifier namespacing the blueprint.
|
608
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
609
609
|
# @param [Hash] opts the optional parameters
|
610
610
|
# @option opts [Float] :offset index to start result set from
|
611
611
|
# @option opts [Float] :limit number of records to return
|
612
612
|
# @option opts [Array<String>] :include comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets
|
613
613
|
# @option opts [Array<String>] :filter_node limit to assets that are related to a node matching type/code
|
614
|
-
# @option opts [Array<String>] :filter_asset_type type of asset to return
|
614
|
+
# @option opts [Array<String>] :filter_asset_type type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
|
615
615
|
# @return [AssetResultSet]
|
616
616
|
def search_assets(namespace, opts = {})
|
617
617
|
data, _status_code, _headers = search_assets_with_http_info(namespace, opts)
|
@@ -620,13 +620,13 @@ module BlueprintClient
|
|
620
620
|
|
621
621
|
# Search assets
|
622
622
|
# This endpoint provides a way to get assets as a pageable result set, based (optionally) on filters.\nThe include parameter can only be set to `nodes`\n\n###### Find all assets in namespace abc\n`/1/abc/assets`\n\n###### Find all lists for abc:\n`/1/abc/assets?filter[assetType]=lists`\n\n###### Find all assets that are related to a given node of DEP101:\n`/1/abc/assets?filter[node]=departments%2Fdep101`\n\n###### Find all assets that are related to both node DEP101 and DEP102:\n`/1/abc/assets?filter[node]=departments%2Fdep101&filter[node]=departments%2Fdep102`\n\n###### Find all assets that are related to either node DEP101 and DEP102:\n`/1/abc/assets?filter[node]=departments%2Fdep101,departments%2Fdep102`\n
|
623
|
-
# @param namespace identifier namespacing the blueprint.
|
623
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
624
624
|
# @param [Hash] opts the optional parameters
|
625
625
|
# @option opts [Float] :offset index to start result set from
|
626
626
|
# @option opts [Float] :limit number of records to return
|
627
627
|
# @option opts [Array<String>] :include comma separated list of elements to hydrate. Can include children, parents, nodes, and/or assets
|
628
628
|
# @option opts [Array<String>] :filter_node limit to assets that are related to a node matching type/code
|
629
|
-
# @option opts [Array<String>] :filter_asset_type type of asset to return
|
629
|
+
# @option opts [Array<String>] :filter_asset_type type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
|
630
630
|
# @return [Array<(AssetResultSet, Fixnum, Hash)>] AssetResultSet data, response status code and response headers
|
631
631
|
def search_assets_with_http_info(namespace, opts = {})
|
632
632
|
if @api_client.config.debugging
|
@@ -97,7 +97,7 @@ module BlueprintClient
|
|
97
97
|
|
98
98
|
#
|
99
99
|
# 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
|
100
|
-
# @param namespace identifier namespacing the blueprint.
|
100
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
101
101
|
# @param [Hash] opts the optional parameters
|
102
102
|
# @return [nil]
|
103
103
|
def bulk_upload(namespace, opts = {})
|
@@ -107,7 +107,7 @@ module BlueprintClient
|
|
107
107
|
|
108
108
|
#
|
109
109
|
# 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
|
110
|
-
# @param namespace identifier namespacing the blueprint.
|
110
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
111
111
|
# @param [Hash] opts the optional parameters
|
112
112
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
113
113
|
def bulk_upload_with_http_info(namespace, opts = {})
|
@@ -161,7 +161,7 @@ module BlueprintClient
|
|
161
161
|
|
162
162
|
#
|
163
163
|
# Delete a node
|
164
|
-
# @param namespace identifier namespacing the blueprint.
|
164
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
165
165
|
# @param id id identifying a domain model
|
166
166
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
167
167
|
# @param [Hash] opts the optional parameters
|
@@ -173,7 +173,7 @@ module BlueprintClient
|
|
173
173
|
|
174
174
|
#
|
175
175
|
# Delete a node
|
176
|
-
# @param namespace identifier namespacing the blueprint.
|
176
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
177
177
|
# @param id id identifying a domain model
|
178
178
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
179
179
|
# @param [Hash] opts the optional parameters
|
@@ -245,7 +245,7 @@ module BlueprintClient
|
|
245
245
|
|
246
246
|
#
|
247
247
|
# 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
|
248
|
-
# @param namespace identifier namespacing the blueprint.
|
248
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
249
249
|
# @param [Hash] opts the optional parameters
|
250
250
|
# @return [nil]
|
251
251
|
def export_hierarchy(namespace, opts = {})
|
@@ -255,7 +255,7 @@ module BlueprintClient
|
|
255
255
|
|
256
256
|
#
|
257
257
|
# 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
|
258
|
-
# @param namespace identifier namespacing the blueprint.
|
258
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
259
259
|
# @param [Hash] opts the optional parameters
|
260
260
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
261
261
|
def export_hierarchy_with_http_info(namespace, opts = {})
|
@@ -310,7 +310,7 @@ module BlueprintClient
|
|
310
310
|
# Get ancestor nodes
|
311
311
|
# A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
|
312
312
|
# @param id id identifying a domain model
|
313
|
-
# @param namespace identifier namespacing the blueprint.
|
313
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
314
314
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
315
315
|
# @param [Hash] opts the optional parameters
|
316
316
|
# @option opts [Float] :offset index to start result set from
|
@@ -324,7 +324,7 @@ module BlueprintClient
|
|
324
324
|
# Get ancestor nodes
|
325
325
|
# A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
|
326
326
|
# @param id id identifying a domain model
|
327
|
-
# @param namespace identifier namespacing the blueprint.
|
327
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
328
328
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
329
329
|
# @param [Hash] opts the optional parameters
|
330
330
|
# @option opts [Float] :offset index to start result set from
|
@@ -413,7 +413,7 @@ module BlueprintClient
|
|
413
413
|
# Get child nodes
|
414
414
|
# A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
|
415
415
|
# @param id id identifying a domain model
|
416
|
-
# @param namespace identifier namespacing the blueprint.
|
416
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
417
417
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
418
418
|
# @param [Hash] opts the optional parameters
|
419
419
|
# @option opts [Float] :offset index to start result set from
|
@@ -427,7 +427,7 @@ module BlueprintClient
|
|
427
427
|
# Get child nodes
|
428
428
|
# A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
|
429
429
|
# @param id id identifying a domain model
|
430
|
-
# @param namespace identifier namespacing the blueprint.
|
430
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
431
431
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
432
432
|
# @param [Hash] opts the optional parameters
|
433
433
|
# @option opts [Float] :offset index to start result set from
|
@@ -516,7 +516,7 @@ module BlueprintClient
|
|
516
516
|
# Get descendant nodes
|
517
517
|
# A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
|
518
518
|
# @param id id identifying a domain model
|
519
|
-
# @param namespace identifier namespacing the blueprint.
|
519
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
520
520
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
521
521
|
# @param [Hash] opts the optional parameters
|
522
522
|
# @option opts [Float] :offset index to start result set from
|
@@ -530,7 +530,7 @@ module BlueprintClient
|
|
530
530
|
# Get descendant nodes
|
531
531
|
# A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
|
532
532
|
# @param id id identifying a domain model
|
533
|
-
# @param namespace identifier namespacing the blueprint.
|
533
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
534
534
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
535
535
|
# @param [Hash] opts the optional parameters
|
536
536
|
# @option opts [Float] :offset index to start result set from
|
@@ -618,7 +618,7 @@ module BlueprintClient
|
|
618
618
|
|
619
619
|
#
|
620
620
|
# Get details of a given node
|
621
|
-
# @param namespace identifier namespacing the blueprint.
|
621
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
622
622
|
# @param id id identifying a domain model
|
623
623
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
624
624
|
# @param [Hash] opts the optional parameters
|
@@ -631,7 +631,7 @@ module BlueprintClient
|
|
631
631
|
|
632
632
|
#
|
633
633
|
# Get details of a given node
|
634
|
-
# @param namespace identifier namespacing the blueprint.
|
634
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
635
635
|
# @param id id identifying a domain model
|
636
636
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
637
637
|
# @param [Hash] opts the optional parameters
|
@@ -713,7 +713,7 @@ module BlueprintClient
|
|
713
713
|
# Get parent nodes
|
714
714
|
# A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
|
715
715
|
# @param id id identifying a domain model
|
716
|
-
# @param namespace identifier namespacing the blueprint.
|
716
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
717
717
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
718
718
|
# @param [Hash] opts the optional parameters
|
719
719
|
# @option opts [Float] :offset index to start result set from
|
@@ -727,7 +727,7 @@ module BlueprintClient
|
|
727
727
|
# Get parent nodes
|
728
728
|
# A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
|
729
729
|
# @param id id identifying a domain model
|
730
|
-
# @param namespace identifier namespacing the blueprint.
|
730
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
731
731
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
732
732
|
# @param [Hash] opts the optional parameters
|
733
733
|
# @option opts [Float] :offset index to start result set from
|
@@ -815,7 +815,7 @@ module BlueprintClient
|
|
815
815
|
|
816
816
|
#
|
817
817
|
# Replaces the node with the data sent in the body
|
818
|
-
# @param namespace identifier namespacing the blueprint.
|
818
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
819
819
|
# @param id id identifying a domain model
|
820
820
|
# @param body node
|
821
821
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
@@ -828,7 +828,7 @@ module BlueprintClient
|
|
828
828
|
|
829
829
|
#
|
830
830
|
# Replaces the node with the data sent in the body
|
831
|
-
# @param namespace identifier namespacing the blueprint.
|
831
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
832
832
|
# @param id id identifying a domain model
|
833
833
|
# @param body node
|
834
834
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
@@ -909,7 +909,7 @@ module BlueprintClient
|
|
909
909
|
end
|
910
910
|
|
911
911
|
# Search nodes
|
912
|
-
# 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[
|
912
|
+
# 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
|
913
913
|
# @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
|
914
914
|
# @param [Hash] opts the optional parameters
|
915
915
|
# @option opts [Float] :offset index to start result set from
|
@@ -922,7 +922,8 @@ module BlueprintClient
|
|
922
922
|
# @option opts [Array<String>] :filter_ancestor limit to nodes with ancestor matching type/code
|
923
923
|
# @option opts [Array<String>] :filter_descendant limit to nodes with descendant matching type/code
|
924
924
|
# @option opts [BOOLEAN] :filter_has_assets limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets
|
925
|
-
# @option opts [Array<String>] :filter_asset_type type of asset to return
|
925
|
+
# @option opts [Array<String>] :filter_asset_type type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
|
926
|
+
# @option opts [Array<String>] :filter_asset_type2 type of asset to return. Version 2. This filters the results by asset type, but returns all the assets associated with the result.
|
926
927
|
# @option opts [Date] :filter_from limit to results valid after this date, format is ISO8601 date
|
927
928
|
# @option opts [Date] :filter_to limit to results valid before this date, format is ISO8601
|
928
929
|
# @option opts [String] :q_node query term(s) to search for nodes. Allows wildcard searching with '*'
|
@@ -938,7 +939,7 @@ module BlueprintClient
|
|
938
939
|
end
|
939
940
|
|
940
941
|
# Search nodes
|
941
|
-
# 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[
|
942
|
+
# 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
|
942
943
|
# @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
|
943
944
|
# @param [Hash] opts the optional parameters
|
944
945
|
# @option opts [Float] :offset index to start result set from
|
@@ -951,7 +952,8 @@ module BlueprintClient
|
|
951
952
|
# @option opts [Array<String>] :filter_ancestor limit to nodes with ancestor matching type/code
|
952
953
|
# @option opts [Array<String>] :filter_descendant limit to nodes with descendant matching type/code
|
953
954
|
# @option opts [BOOLEAN] :filter_has_assets limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets
|
954
|
-
# @option opts [Array<String>] :filter_asset_type type of asset to return
|
955
|
+
# @option opts [Array<String>] :filter_asset_type type of asset to return. Depricated. This filters the results by asset type, but incorrectly only returns the assets of thay type. Use asset.type.2
|
956
|
+
# @option opts [Array<String>] :filter_asset_type2 type of asset to return. Version 2. This filters the results by asset type, but returns all the assets associated with the result.
|
955
957
|
# @option opts [Date] :filter_from limit to results valid after this date, format is ISO8601 date
|
956
958
|
# @option opts [Date] :filter_to limit to results valid before this date, format is ISO8601
|
957
959
|
# @option opts [String] :q_node query term(s) to search for nodes. Allows wildcard searching with '*'
|
@@ -1081,6 +1083,12 @@ module BlueprintClient
|
|
1081
1083
|
|
1082
1084
|
|
1083
1085
|
|
1086
|
+
|
1087
|
+
|
1088
|
+
|
1089
|
+
|
1090
|
+
|
1091
|
+
|
1084
1092
|
|
1085
1093
|
|
1086
1094
|
|
@@ -1104,6 +1112,7 @@ module BlueprintClient
|
|
1104
1112
|
query_params[:'filter[descendant]'] = @api_client.build_collection_param(opts[:'filter_descendant'], :csv) if opts[:'filter_descendant']
|
1105
1113
|
query_params[:'filter[hasAssets]'] = opts[:'filter_has_assets'] if opts[:'filter_has_assets']
|
1106
1114
|
query_params[:'filter[assetType]'] = @api_client.build_collection_param(opts[:'filter_asset_type'], :csv) if opts[:'filter_asset_type']
|
1115
|
+
query_params[:'filter[asset.type]'] = @api_client.build_collection_param(opts[:'filter_asset_type2'], :csv) if opts[:'filter_asset_type2']
|
1107
1116
|
query_params[:'filter[from]'] = opts[:'filter_from'] if opts[:'filter_from']
|
1108
1117
|
query_params[:'filter[to]'] = opts[:'filter_to'] if opts[:'filter_to']
|
1109
1118
|
query_params[:'q[node]'] = opts[:'q_node'] if opts[:'q_node']
|
@@ -1146,7 +1155,7 @@ module BlueprintClient
|
|
1146
1155
|
|
1147
1156
|
#
|
1148
1157
|
# Perform a partial update of a node
|
1149
|
-
# @param namespace identifier namespacing the blueprint.
|
1158
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
1150
1159
|
# @param id id identifying a domain model
|
1151
1160
|
# @param body node
|
1152
1161
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|
@@ -1159,7 +1168,7 @@ module BlueprintClient
|
|
1159
1168
|
|
1160
1169
|
#
|
1161
1170
|
# Perform a partial update of a node
|
1162
|
-
# @param namespace identifier namespacing the blueprint.
|
1171
|
+
# @param namespace identifier namespacing the blueprint. It must start with a letter or underscore and can only be followed by letters, numbers and underscores.
|
1163
1172
|
# @param id id identifying a domain model
|
1164
1173
|
# @param body node
|
1165
1174
|
# @param type subtype of Node, e.g. 'modules', 'departments', etc.
|