Class: XbimAim::FacilitiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FacilitiesApi 



19
20
21
 
# File 'lib/xbim_aim/api/facilities_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/facilities_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#facilities_add_document_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, document, opts = {}) ⇒ Document

Adds a new document to a model entity <span style=‘font-size: 17px;’>Summary:</span>Adds a new document to a model entity.<br/>Return Type: Document<br/><br/>



31
32
33
34
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 31

def facilities_add_document_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, document, opts = {})
  data, _status_code, _headers = facilities_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts)
  data
end

#facilities_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts = {}) ⇒ Array<(Document, Integer, Hash)>

Adds a new document to a model entity &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Adds a new document to a model entity.&lt;br/&gt;Return Type: &lt;b&gt;Document&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;



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
110
111
112
113
114
115
116
117
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 45

def facilities_add_document_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_and_tenantid"
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_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 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_and_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Facilities(AssetModelId={assetModelId}, EntityId={entityId})/DocumentEntities'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_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(document)

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

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_add_document_by_assetmodelid_and_entityid_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: FacilitiesApi#facilities_add_document_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#facilities_as_of_by_date_and_tenantid(date, tenant_id, region, opts = {}) ⇒ ODataListResponseOfEntity

Get Facilities as of by date and tenantid <span style=‘font-size: 17px;’>Summary:</span>Return Type: ODataListResponseOfEntity<br/>For more information about OData responses <a href=‘www.odata.org/getting-started/understand-odata-in-6-steps/’>link</a>.<br/><br/>

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.



133
134
135
136
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 133

def facilities_as_of_by_date_and_tenantid(date, tenant_id, region, opts = {})
  data, _status_code, _headers = facilities_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts)
  data
end

#facilities_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts = {}) ⇒ Array<(ODataListResponseOfEntity, Integer, Hash)>

Get Facilities as of by date and tenantid &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;ODataListResponseOfEntity&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;

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.



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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 152

def facilities_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_as_of_by_date_and_tenantid ...'
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling FacilitiesApi.facilities_as_of_by_date_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 FacilitiesApi.facilities_as_of_by_date_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 FacilitiesApi.facilities_as_of_by_date_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}/Facilities/AsOf(date={date})'.sub('{' + 'date' + '}', CGI.escape(date.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] || 'ODataListResponseOfEntity'

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_as_of_by_date_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: FacilitiesApi#facilities_as_of_by_date_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#facilities_get_available_properties_by_assetid_and_tenantid(asset_id, tenant_id, region, opts = {}) ⇒ ODataListResponseOfAttributeDefinition

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

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.



234
235
236
237
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 234

def facilities_get_available_properties_by_assetid_and_tenantid(asset_id, tenant_id, region, opts = {})
  data, _status_code, _headers = facilities_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts)
  data
end

#facilities_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts = {}) ⇒ Array<(ODataListResponseOfAttributeDefinition, Integer, Hash)>

Gets the Properties available on this Model &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the Properties available on this Model.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfAttributeDefinition&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;

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.



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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 253

def facilities_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_get_available_properties_by_assetid_and_tenantid ...'
  end
  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling FacilitiesApi.facilities_get_available_properties_by_assetid_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 FacilitiesApi.facilities_get_available_properties_by_assetid_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 FacilitiesApi.facilities_get_available_properties_by_assetid_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}/Facilities/GetAvailableProperties(assetId={assetId})'.sub('{' + 'assetId' + '}', CGI.escape(asset_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] || 'ODataListResponseOfAttributeDefinition'

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_get_available_properties_by_assetid_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: FacilitiesApi#facilities_get_available_properties_by_assetid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#facilities_get_by_tenantid(tenant_id, region, opts = {}) ⇒ ODataListResponseOfFacility

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

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.



334
335
336
337
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 334

def facilities_get_by_tenantid(tenant_id, region, opts = {})
  data, _status_code, _headers = facilities_get_by_tenantid_with_http_info(tenant_id, region, opts)
  data
end

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

Returns the EntitySet Facilities &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Returns the EntitySet Facilities.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfFacility&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;

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.



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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 352

def facilities_get_by_tenantid_with_http_info(tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_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 FacilitiesApi.facilities_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 FacilitiesApi.facilities_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}/Facilities'.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] || 'ODataListResponseOfFacility'

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_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: FacilitiesApi#facilities_get_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {}) ⇒ Facility

Get Facilities single entity by assetmodelid, entityid and tenantid <span style=‘font-size: 17px;’>Summary:</span>Return Type: Facility<br/><br/>

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :select (String) —

    Selects which properties to include in the response.



426
427
428
429
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 426

def facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {})
  data, _status_code, _headers = facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts)
  data
end

#facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts = {}) ⇒ Array<(Facility, Integer, Hash)>

Get Facilities single entity by assetmodelid, entityid and tenantid &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Facility&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Options Hash (opts):

  • :expand (String) —

    Expands related entities inline.

  • :select (String) —

    Selects which properties to include in the response.



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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 441

def facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_get_single_entity_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid"
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling FacilitiesApi.facilities_get_single_entity_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_get_single_entity_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_get_single_entity_by_assetmodelid_and_entityid_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}/Facilities(AssetModelId={assetModelId}, EntityId={entityId})'.sub('{' + 'assetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'entityId' + '}', CGI.escape(entity_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] || 'Facility'

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_get_single_entity_by_assetmodelid_and_entityid_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: FacilitiesApi#facilities_get_single_entity_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#facilities_patch_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, patch, opts = {}) ⇒ Entity

Patch Facilities by assetmodelid, entityid and tenantid <span style=‘font-size: 17px;’>Summary:</span>Return Type: Entity<br/><br/>



517
518
519
520
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 517

def facilities_patch_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, patch, opts = {})
  data, _status_code, _headers = facilities_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts)
  data
end

#facilities_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts = {}) ⇒ Array<(Entity, Integer, Hash)>

Patch Facilities by assetmodelid, entityid and tenantid &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Return Type: &lt;b&gt;Entity&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;



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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 531

def facilities_patch_by_assetmodelid_and_entityid_and_tenantid_with_http_info(asset_model_id, entity_id, tenant_id, region, patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_and_tenantid"
  end
  # verify the required parameter 'entity_id' is set
  if @api_client.config.client_side_validation && entity_id.nil?
    fail ArgumentError, "Missing the required parameter 'entity_id' when calling FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_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 FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_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 'patch' is set
  if @api_client.config.client_side_validation && patch.nil?
    fail ArgumentError, "Missing the required parameter 'patch' when calling FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_and_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Facilities(AssetModelId={AssetModelId}, EntityId={EntityId})'.sub('{' + 'AssetModelId' + '}', CGI.escape(asset_model_id.to_s)).sub('{' + 'EntityId' + '}', CGI.escape(entity_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(patch)

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

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_patch_by_assetmodelid_and_entityid_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: FacilitiesApi#facilities_patch_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#facilities_post_by_tenantid(tenant_id, region, facility, opts = {}) ⇒ Entity

Post a new entity to EntitySet Facilities <span style=‘font-size: 17px;’>Summary:</span>Post a new entity to EntitySet Facilities.<br/>Return Type: Entity<br/><br/>



612
613
614
615
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 612

def facilities_post_by_tenantid(tenant_id, region, facility, opts = {})
  data, _status_code, _headers = facilities_post_by_tenantid_with_http_info(tenant_id, region, facility, opts)
  data
end

#facilities_post_by_tenantid_with_http_info(tenant_id, region, facility, opts = {}) ⇒ Array<(Entity, Integer, Hash)>

Post a new entity to EntitySet Facilities &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Post a new entity to EntitySet Facilities.&lt;br/&gt;Return Type: &lt;b&gt;Entity&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;



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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
 
# File 'lib/xbim_aim/api/facilities_api.rb', line 624

def facilities_post_by_tenantid_with_http_info(tenant_id, region, facility, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FacilitiesApi.facilities_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 FacilitiesApi.facilities_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 FacilitiesApi.facilities_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 'facility' is set
  if @api_client.config.client_side_validation && facility.nil?
    fail ArgumentError, "Missing the required parameter 'facility' when calling FacilitiesApi.facilities_post_by_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Facilities'.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(facility)

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

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

  new_options = opts.merge(
    :operation => :"FacilitiesApi.facilities_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: FacilitiesApi#facilities_post_by_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end