Class: XbimAim::ModelsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_aim/api/models_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ModelsApi

Returns a new instance of ModelsApi.



19
20
21
 
# File 'lib/xbim_aim/api/models_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/xbim_aim/api/models_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#models_assign_by_tenantid_and_assetmodelid(tenant_id, asset_model_id, region, parameters, opts = {}) ⇒ nil

Assigns a user to the given role on the model <span style=‘font-size: 17px;’>Summary:</span>Assigns a user to the given role on the model.<br/>Return Type: <br/><br/>

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • asset_model_id (Integer)
  • region (String) —

    The data center region the data resides in

  • parameters (InlineObject4)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


30
31
32
33
 
# File 'lib/xbim_aim/api/models_api.rb', line 30

def models_assign_by_tenantid_and_assetmodelid(tenant_id, asset_model_id, region, parameters, opts = {})
  models_assign_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, parameters, opts)
  nil
end

#models_assign_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, parameters, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Assigns a user to the given role on the model &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Assigns a user to the given role on the model.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • asset_model_id (Integer)
  • region (String) —

    The data center region the data resides in

  • parameters (InlineObject4)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/xbim_aim/api/models_api.rb', line 43

def models_assign_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_assign_by_tenantid_and_assetmodelid ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_assign_by_tenantid_and_assetmodelid"
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_assign_by_tenantid_and_assetmodelid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_assign_by_tenantid_and_assetmodelid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'parameters' is set
  if @api_client.config.client_side_validation && parameters.nil?
    fail ArgumentError, "Missing the required parameter 'parameters' when calling ModelsApi.models_assign_by_tenantid_and_assetmodelid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Roles.Assign'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(parameters)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_assign_by_tenantid_and_assetmodelid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_assign_by_tenantid_and_assetmodelid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_delete_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {}) ⇒ nil

Archive a model for future deletion <span style=‘font-size: 17px;’>Summary:</span>Archive a model for future deletion.<br/>Return Type: <br/><br/>

Parameters:

  • asset_model_id (Integer) —

    key: AssetModelId

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    If-Match header

Returns:

  • (nil) 


119
120
121
122
 
# File 'lib/xbim_aim/api/models_api.rb', line 119

def models_delete_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {})
  models_delete_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts)
  nil
end

#models_delete_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Archive a model for future deletion &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Archive a model for future deletion.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer) —

    key: AssetModelId

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :if_match (String) —

    If-Match header

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/xbim_aim/api/models_api.rb', line 132

def models_delete_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_delete_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_delete_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_delete_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_delete_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_delete_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_delete_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid(asset_model_id, target_model_id, tenant_id, region, opts = {}) ⇒ ODataListResponseOfModelMappingReport

Generates a model mappings between two distinct models <span style=‘font-size: 17px;’>Summary:</span>Generates a model mappings between two distinct models.<br/>Return Type: ODataListResponseOfModelMappingReport<br/>For more information about OData responses <a href=‘www.odata.org/getting-started/understand-odata-in-6-steps/’>link</a>.<br/><br/>

Parameters:

  • asset_model_id (Integer) —

    The model ID to baseline

  • target_model_id (Integer) —

    The latest Model ID to compare against

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:



207
208
209
210
 
# File 'lib/xbim_aim/api/models_api.rb', line 207

def models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid(asset_model_id, target_model_id, tenant_id, region, opts = {})
  data, _status_code, _headers = models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid_with_http_info(asset_model_id, target_model_id, tenant_id, region, opts)
  data
end

#models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid_with_http_info(asset_model_id, target_model_id, tenant_id, region, opts = {}) ⇒ Array<(ODataListResponseOfModelMappingReport, Integer, Hash)>

Generates a model mappings between two distinct models &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Generates a model mappings between two distinct models.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfModelMappingReport&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer) —

    The model ID to baseline

  • target_model_id (Integer) —

    The latest Model ID to compare against

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/xbim_aim/api/models_api.rb', line 227

def models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid_with_http_info(asset_model_id, target_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid"
  end
  # verify the required parameter 'target_model_id' is set
  if @api_client.config.client_side_validation && target_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_model_id' when calling ModelsApi.models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/GenerateModelMapping(id={targetModelId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'targetModelId' + '}', CGI.escape(target_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ODataListResponseOfModelMappingReport'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_generate_model_mapping_by_assetmodelid_and_targetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_get_by_tenantid(tenant_id, region, opts = {}) ⇒ ODataListResponseOfModel

Returns the EntitySet Models <span style=‘font-size: 17px;’>Summary:</span>Returns the EntitySet Models.<br/>Return Type: ODataListResponseOfModel<br/>For more information about OData responses <a href=‘www.odata.org/getting-started/understand-odata-in-6-steps/’>link</a>.<br/><br/>

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:



312
313
314
315
 
# File 'lib/xbim_aim/api/models_api.rb', line 312

def models_get_by_tenantid(tenant_id, region, opts = {})
  data, _status_code, _headers = models_get_by_tenantid_with_http_info(tenant_id, region, opts)
  data
end

#models_get_by_tenantid_with_http_info(tenant_id, region, opts = {}) ⇒ Array<(ODataListResponseOfModel, Integer, Hash)>

Returns the EntitySet Models &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the EntitySet Models.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfModel&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:

  • (Array<(ODataListResponseOfModel, Integer, Hash)>) —

    ODataListResponseOfModel data, response status code and response headers



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/xbim_aim/api/models_api.rb', line 330

def models_get_by_tenantid_with_http_info(tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_get_by_tenantid ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_get_by_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_get_by_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ODataListResponseOfModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_get_by_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_get_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_get_single_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {}) ⇒ Model

Returns the entity with the key from Models <span style=‘font-size: 17px;’>Summary:</span>Returns the entity with the key from Models.<br/>Return Type: Model<br/><br/>

Parameters:

  • asset_model_id (Integer) —

    key: AssetModelId

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :select (String) —

    Selects which properties to include in the response.

Returns:



403
404
405
406
 
# File 'lib/xbim_aim/api/models_api.rb', line 403

def models_get_single_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {})
  data, _status_code, _headers = models_get_single_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts)
  data
end

#models_get_single_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {}) ⇒ Array<(Model, Integer, Hash)>

Returns the entity with the key from Models &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the entity with the key from Models.&lt;br/&gt;Return Type: &lt;b&gt;Model&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer) —

    key: AssetModelId

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :select (String) —

    Selects which properties to include in the response.

Returns:

  • (Array<(Model, Integer, Hash)>) —

    Model data, response status code and response headers



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/xbim_aim/api/models_api.rb', line 417

def models_get_single_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_get_single_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_get_single_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_get_single_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_get_single_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Model'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_get_single_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_get_single_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_member_access_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {}) ⇒ ODataListResponseOfMemberPermission

Gets the list of users with access to this model and their permissions <span style=‘font-size: 17px;’>Summary:</span>Gets the list of users with access to this model and their permissions.<br/>Return Type: ODataListResponseOfMemberPermission<br/>For more information about OData responses <a href=‘www.odata.org/getting-started/understand-odata-in-6-steps/’>link</a>.<br/><br/>

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:



494
495
496
497
 
# File 'lib/xbim_aim/api/models_api.rb', line 494

def models_member_access_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {})
  data, _status_code, _headers = models_member_access_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts)
  data
end

#models_member_access_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {}) ⇒ Array<(ODataListResponseOfMemberPermission, Integer, Hash)>

Gets the list of users with access to this model and their permissions &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the list of users with access to this model and their permissions.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfMemberPermission&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/xbim_aim/api/models_api.rb', line 513

def models_member_access_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_member_access_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_member_access_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_member_access_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_member_access_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/MemberAccess'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ODataListResponseOfMemberPermission'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_member_access_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_member_access_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_move_by_tenantid_and_assetmodelid(tenant_id, asset_model_id, region, model_move_parameters, opts = {}) ⇒ Model

Move a model to another asset in this tenant <span style=‘font-size: 17px;’>Summary:</span>Move a model to another asset in this tenant.<br/>Return Type: Model<br/><br/>

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • asset_model_id (Integer) —

    The Model ID

  • region (String) —

    The data center region the data resides in

  • model_move_parameters (InlineObject3)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



589
590
591
592
 
# File 'lib/xbim_aim/api/models_api.rb', line 589

def models_move_by_tenantid_and_assetmodelid(tenant_id, asset_model_id, region, model_move_parameters, opts = {})
  data, _status_code, _headers = models_move_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, model_move_parameters, opts)
  data
end

#models_move_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, model_move_parameters, opts = {}) ⇒ Array<(Model, Integer, Hash)>

Move a model to another asset in this tenant &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Move a model to another asset in this tenant.&lt;br/&gt;Return Type: &lt;b&gt;Model&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • asset_model_id (Integer) —

    The Model ID

  • region (String) —

    The data center region the data resides in

  • model_move_parameters (InlineObject3)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Model, Integer, Hash)>) —

    Model data, response status code and response headers



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/xbim_aim/api/models_api.rb', line 602

def models_move_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, model_move_parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_move_by_tenantid_and_assetmodelid ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_move_by_tenantid_and_assetmodelid"
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_move_by_tenantid_and_assetmodelid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_move_by_tenantid_and_assetmodelid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'model_move_parameters' is set
  if @api_client.config.client_side_validation && model_move_parameters.nil?
    fail ArgumentError, "Missing the required parameter 'model_move_parameters' when calling ModelsApi.models_move_by_tenantid_and_assetmodelid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Asset.Move'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(model_move_parameters)

  # return_type
  return_type = opts[:debug_return_type] || 'Model'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_move_by_tenantid_and_assetmodelid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_move_by_tenantid_and_assetmodelid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_patch_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, model, opts = {}) ⇒ Model

Edit an existing model <span style=‘font-size: 17px;’>Summary:</span>Edit an existing model.<br/>Return Type: Model<br/><br/>

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • model (ModelEdit) —

    The entity to patch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



680
681
682
683
 
# File 'lib/xbim_aim/api/models_api.rb', line 680

def models_patch_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, model, opts = {})
  data, _status_code, _headers = models_patch_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, model, opts)
  data
end

#models_patch_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, model, opts = {}) ⇒ Array<(Model, Integer, Hash)>

Edit an existing model &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Edit an existing model.&lt;br/&gt;Return Type: &lt;b&gt;Model&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • model (ModelEdit) —

    The entity to patch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Model, Integer, Hash)>) —

    Model data, response status code and response headers



693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 
# File 'lib/xbim_aim/api/models_api.rb', line 693

def models_patch_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_patch_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_patch_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_patch_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_patch_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling ModelsApi.models_patch_by_assetmodelid_and_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(model)

  # return_type
  return_type = opts[:debug_return_type] || 'Model'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_patch_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_patch_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_permissions_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {}) ⇒ UserPermissions

Gets the effective permissions for the current user <span style=‘font-size: 17px;’>Summary:</span>Gets the effective permissions for the current user.<br/>Return Type: UserPermissions<br/><br/>

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :select (String) —

    Selects which properties to include in the response.

Returns:



772
773
774
775
 
# File 'lib/xbim_aim/api/models_api.rb', line 772

def models_permissions_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {})
  data, _status_code, _headers = models_permissions_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts)
  data
end

#models_permissions_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {}) ⇒ Array<(UserPermissions, Integer, Hash)>

Gets the effective permissions for the current user &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the effective permissions for the current user.&lt;br/&gt;Return Type: &lt;b&gt;UserPermissions&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :select (String) —

    Selects which properties to include in the response.

Returns:

  • (Array<(UserPermissions, Integer, Hash)>) —

    UserPermissions data, response status code and response headers



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'lib/xbim_aim/api/models_api.rb', line 786

def models_permissions_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_permissions_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_permissions_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_permissions_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_permissions_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Permissions'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UserPermissions'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_permissions_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_permissions_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_post_by_tenantid(tenant_id, region, model, opts = {}) ⇒ Model

Creates a new Model for the given Asset <span style=‘font-size: 17px;’>Summary:</span>Creates a new Model for the given Asset.<br/>The ability to create Models may be limited by access level.<br/>Return Type: Model<br/><br/>

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • model (ModelCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



856
857
858
859
 
# File 'lib/xbim_aim/api/models_api.rb', line 856

def models_post_by_tenantid(tenant_id, region, model, opts = {})
  data, _status_code, _headers = models_post_by_tenantid_with_http_info(tenant_id, region, model, opts)
  data
end

#models_post_by_tenantid_with_http_info(tenant_id, region, model, opts = {}) ⇒ Array<(Model, Integer, Hash)>

Creates a new Model for the given Asset &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Creates a new Model for the given Asset.&lt;br/&gt;The ability to create Models may be limited by access level.&lt;br/&gt;Return Type: &lt;b&gt;Model&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • model (ModelCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Model, Integer, Hash)>) —

    Model data, response status code and response headers



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
 
# File 'lib/xbim_aim/api/models_api.rb', line 868

def models_post_by_tenantid_with_http_info(tenant_id, region, model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_post_by_tenantid ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_post_by_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_post_by_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling ModelsApi.models_post_by_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(model)

  # return_type
  return_type = opts[:debug_return_type] || 'Model'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_post_by_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_post_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_reprocess_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {}) ⇒ Boolean

Requeues a model for processing and import <span style=‘font-size: 17px;’>Summary:</span>Requeues a model for processing and import.<br/>Return Type: boolean<br/><br/>

Parameters:

  • asset_model_id (Integer) —

    The model ID to requeue

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Boolean) 


941
942
943
944
 
# File 'lib/xbim_aim/api/models_api.rb', line 941

def models_reprocess_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {})
  data, _status_code, _headers = models_reprocess_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts)
  data
end

#models_reprocess_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {}) ⇒ Array<(Boolean, Integer, Hash)>

Requeues a model for processing and import &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Requeues a model for processing and import.&lt;br/&gt;Return Type: &lt;b&gt;boolean&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer) —

    The model ID to requeue

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Boolean, Integer, Hash)>) —

    Boolean data, response status code and response headers



953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/xbim_aim/api/models_api.rb', line 953

def models_reprocess_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_reprocess_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_reprocess_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_reprocess_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_reprocess_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Reprocess()'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Boolean'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_reprocess_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_reprocess_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_revoke_by_tenantid_and_assetmodelid(tenant_id, asset_model_id, region, parameters, opts = {}) ⇒ nil

Revokes a user from the given role on the model <span style=‘font-size: 17px;’>Summary:</span>Revokes a user from the given role on the model.<br/>Return Type: <br/><br/>

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • asset_model_id (Integer)
  • region (String) —

    The data center region the data resides in

  • parameters (InlineObject5)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1022
1023
1024
1025
 
# File 'lib/xbim_aim/api/models_api.rb', line 1022

def models_revoke_by_tenantid_and_assetmodelid(tenant_id, asset_model_id, region, parameters, opts = {})
  models_revoke_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, parameters, opts)
  nil
end

#models_revoke_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, parameters, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Revokes a user from the given role on the model &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Revokes a user from the given role on the model.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • asset_model_id (Integer)
  • region (String) —

    The data center region the data resides in

  • parameters (InlineObject5)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/xbim_aim/api/models_api.rb', line 1035

def models_revoke_by_tenantid_and_assetmodelid_with_http_info(tenant_id, asset_model_id, region, parameters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_revoke_by_tenantid_and_assetmodelid ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_revoke_by_tenantid_and_assetmodelid"
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_revoke_by_tenantid_and_assetmodelid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_revoke_by_tenantid_and_assetmodelid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'parameters' is set
  if @api_client.config.client_side_validation && parameters.nil?
    fail ArgumentError, "Missing the required parameter 'parameters' when calling ModelsApi.models_revoke_by_tenantid_and_assetmodelid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Roles.Revoke'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(parameters)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_revoke_by_tenantid_and_assetmodelid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_revoke_by_tenantid_and_assetmodelid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_roles_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {}) ⇒ ODataListResponseOfRole

Gets the roles for the given Model <span style=‘font-size: 17px;’>Summary:</span>Gets the roles for the given Model.<br/>Return Type: ODataListResponseOfRole<br/>For more information about OData responses <a href=‘www.odata.org/getting-started/understand-odata-in-6-steps/’>link</a>.<br/><br/>

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:



1117
1118
1119
1120
 
# File 'lib/xbim_aim/api/models_api.rb', line 1117

def models_roles_by_assetmodelid_and_tenantid(asset_model_id, tenant_id, region, opts = {})
  data, _status_code, _headers = models_roles_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts)
  data
end

#models_roles_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {}) ⇒ Array<(ODataListResponseOfRole, Integer, Hash)>

Gets the roles for the given Model &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the roles for the given Model.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfRole&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :filter (String) —

    Filters the results, based on a Boolean condition.

  • :select (String) —

    Selects which properties to include in the response.

  • :orderby (String) —

    Sorts the results.

  • :top (Integer) —

    Returns only the first n results.

  • :skip (Integer) —

    Skips the first n results.

  • :count (Boolean) —

    Includes a count of the matching results in the response.

Returns:

  • (Array<(ODataListResponseOfRole, Integer, Hash)>) —

    ODataListResponseOfRole data, response status code and response headers



1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/xbim_aim/api/models_api.rb', line 1136

def models_roles_by_assetmodelid_and_tenantid_with_http_info(asset_model_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_roles_by_assetmodelid_and_tenantid ...'
  end
  # verify the required parameter 'asset_model_id' is set
  if @api_client.config.client_side_validation && asset_model_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_model_id' when calling ModelsApi.models_roles_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_roles_by_assetmodelid_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_roles_by_assetmodelid_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({AssetModelId})/Roles'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
  query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
  query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
  query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/json;odata.metadata=none', 'application/json;odata.metadata=minimal', 'application/json;odata.metadata=full', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ODataListResponseOfRole'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_roles_by_assetmodelid_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_roles_by_assetmodelid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#models_supercede_by_key_and_tenantid(key, tenant_id, region, file, opts = {}) ⇒ FileUploadResult

Supercede an existing model with a new version <span style=‘font-size: 17px;’>Summary:</span>Supercede an existing model with a new version.<br/>Return Type: FileUploadResult<br/><br/>

Parameters:

  • key (Integer) —

    The ID of the model to supercede.

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • file (File) —

    A model file in the correct format (IFC / IFCZip / Zip)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :revision (String) —

    A version identifier for the model.

  • :status (String) —

    A status identifier for the model

  • :model_id (Integer) —

    The ID of the model to be populated with the data. If not defined, a new model will be created.

  • :original_filename (String) —

    The original filename of the model, for zipped models

Returns:



1216
1217
1218
1219
 
# File 'lib/xbim_aim/api/models_api.rb', line 1216

def models_supercede_by_key_and_tenantid(key, tenant_id, region, file, opts = {})
  data, _status_code, _headers = models_supercede_by_key_and_tenantid_with_http_info(key, tenant_id, region, file, opts)
  data
end

#models_supercede_by_key_and_tenantid_with_http_info(key, tenant_id, region, file, opts = {}) ⇒ Array<(FileUploadResult, Integer, Hash)>

Supercede an existing model with a new version &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Supercede an existing model with a new version.&lt;br/&gt;Return Type: &lt;b&gt;FileUploadResult&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • key (Integer) —

    The ID of the model to supercede.

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • file (File) —

    A model file in the correct format (IFC / IFCZip / Zip)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :revision (String) —

    A version identifier for the model.

  • :status (String) —

    A status identifier for the model

  • :model_id (Integer) —

    The ID of the model to be populated with the data. If not defined, a new model will be created.

  • :original_filename (String) —

    The original filename of the model, for zipped models

Returns:

  • (Array<(FileUploadResult, Integer, Hash)>) —

    FileUploadResult data, response status code and response headers



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/xbim_aim/api/models_api.rb', line 1233

def models_supercede_by_key_and_tenantid_with_http_info(key, tenant_id, region, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelsApi.models_supercede_by_key_and_tenantid ...'
  end
  # verify the required parameter 'key' is set
  if @api_client.config.client_side_validation && key.nil?
    fail ArgumentError, "Missing the required parameter 'key' when calling ModelsApi.models_supercede_by_key_and_tenantid"
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling ModelsApi.models_supercede_by_key_and_tenantid"
  end
  # verify the required parameter 'region' is set
  if @api_client.config.client_side_validation && region.nil?
    fail ArgumentError, "Missing the required parameter 'region' when calling ModelsApi.models_supercede_by_key_and_tenantid"
  end
  # verify enum value
  allowable_values = ["UK", "WestEurope", "Sandbox"]
  if @api_client.config.client_side_validation && !allowable_values.include?(region)
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling ModelsApi.models_supercede_by_key_and_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Models({key})/Supercede()'.sub('{' + 'key' + '}', CGI.escape(key.to_s)).sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'region' + '}', CGI.escape(region.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['file'] = file
  form_params['revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  form_params['status'] = opts[:'status'] if !opts[:'status'].nil?
  form_params['modelId'] = opts[:'model_id'] if !opts[:'model_id'].nil?
  form_params['originalFilename'] = opts[:'original_filename'] if !opts[:'original_filename'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FileUploadResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"ModelsApi.models_supercede_by_key_and_tenantid",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ModelsApi#models_supercede_by_key_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end