Class: XbimAim::ComponentsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ComponentsApi

Returns a new instance of ComponentsApi.



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

def api_client
  @api_client
end

Instance Method Details

#components_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/>

Parameters:

  • asset_model_id (Integer) —

    The model Id

  • entity_id (Integer) —

    The unique identifier for the target entity (Entity Label)

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • document (DocumentCreate) —

    A document to create

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

    the optional parameters

Returns:



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

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

#components_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;

Parameters:

  • asset_model_id (Integer) —

    The model Id

  • entity_id (Integer) —

    The unique identifier for the target entity (Entity Label)

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • document (DocumentCreate) —

    A document to create

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

    the optional parameters

Returns:

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

    Document data, response status code and response headers



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/components_api.rb', line 45

def components_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: ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_add_document_by_assetmodelid_and_entityid_and_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Components(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 => :"ComponentsApi.components_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: ComponentsApi#components_add_document_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get Components 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/>

Parameters:

  • date (Time)
  • 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:



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

def components_as_of_by_date_and_tenantid(date, tenant_id, region, opts = {})
  data, _status_code, _headers = components_as_of_by_date_and_tenantid_with_http_info(date, tenant_id, region, opts)
  data
end

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

Get Components 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;

Parameters:

  • date (Time)
  • 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<(ODataListResponseOfEntity, Integer, Hash)>) —

    ODataListResponseOfEntity data, response status code and response headers



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/components_api.rb', line 152

def components_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: ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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}/Components/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 => :"ComponentsApi.components_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: ComponentsApi#components_as_of_by_date_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#components_containing_spaces_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {}) ⇒ ODataListResponseOfSpace

Gets the Spaces this Component is placed in, based on Footprint data <span style=‘font-size: 17px;’>Summary:</span>Gets the Spaces this Component is placed in, based on Footprint data.<br/>Returns the Spaces where the component is wholly contained in the volume<br /> This is a derived value based on the component geometry being wholly within the spatial footprint, and wholly within the Z-axis range of the space.<br /> A ‘tolerance’ can be provided to extend or reduce the buffer included at the boundaries of the component<br />.<br/>Return Type: ODataListResponseOfSpace<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 assetModel ID of the Component

  • entity_id (Integer) —

    The ID of the Component entity

  • 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.

  • :tolerance (Float) —

    Tolerance in millimeters. Can be negative. Default: 10mm (default to 10.0)

  • :in_same_asset (Boolean) —

    Limit the results to spaces in the same Asset (default to true)

Returns:



237
238
239
240
 
# File 'lib/xbim_aim/api/components_api.rb', line 237

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

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

Gets the Spaces this Component is placed in, based on Footprint data &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the Spaces this Component is placed in, based on Footprint data.&lt;br/&gt;Returns the Spaces where the component is wholly contained in the volume&lt;br /&gt; This is a derived value based on the component geometry being wholly within the spatial footprint, and wholly within the Z-axis range of the space.&lt;br /&gt; A &#39;tolerance&#39; can be provided to extend or reduce the buffer included at the boundaries of the component&lt;br /&gt;.&lt;br/&gt;Return Type: &lt;b&gt;ODataListResponseOfSpace&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 assetModel ID of the Component

  • entity_id (Integer) —

    The ID of the Component entity

  • 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.

  • :tolerance (Float) —

    Tolerance in millimeters. Can be negative. Default: 10mm

  • :in_same_asset (Boolean) —

    Limit the results to spaces in the same Asset

Returns:

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

    ODataListResponseOfSpace data, response status code and response headers



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
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/xbim_aim/api/components_api.rb', line 259

def components_containing_spaces_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: ComponentsApi.components_containing_spaces_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 ComponentsApi.components_containing_spaces_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 ComponentsApi.components_containing_spaces_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 ComponentsApi.components_containing_spaces_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 ComponentsApi.components_containing_spaces_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}/Components(AssetModelId={assetModelId}, EntityId={entityId})/ContainingSpaces'.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[:'$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?
  query_params[:'tolerance'] = opts[:'tolerance'] if !opts[:'tolerance'].nil?
  query_params[:'inSameAsset'] = opts[:'in_same_asset'] if !opts[:'in_same_asset'].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] || 'ODataListResponseOfSpace'

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

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

#components_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/>

Parameters:

  • asset_id (Integer) —

    The unique key for the asset

  • 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:



347
348
349
350
 
# File 'lib/xbim_aim/api/components_api.rb', line 347

def components_get_available_properties_by_assetid_and_tenantid(asset_id, tenant_id, region, opts = {})
  data, _status_code, _headers = components_get_available_properties_by_assetid_and_tenantid_with_http_info(asset_id, tenant_id, region, opts)
  data
end

#components_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;

Parameters:

  • asset_id (Integer) —

    The unique key for the asset

  • 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:



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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/xbim_aim/api/components_api.rb', line 366

def components_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: ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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}/Components/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 => :"ComponentsApi.components_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: ComponentsApi#components_get_available_properties_by_assetid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#components_get_by_tenantid(tenant_id, region, opts = {}) ⇒ ODataListResponseOfComponent

Returns the EntitySet Components <span style=‘font-size: 17px;’>Summary:</span>Returns the EntitySet Components.<br/>Return Type: ODataListResponseOfComponent<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:



447
448
449
450
 
# File 'lib/xbim_aim/api/components_api.rb', line 447

def components_get_by_tenantid(tenant_id, region, opts = {})
  data, _status_code, _headers = components_get_by_tenantid_with_http_info(tenant_id, region, opts)
  data
end

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

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



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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/xbim_aim/api/components_api.rb', line 465

def components_get_by_tenantid_with_http_info(tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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}/Components'.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] || 'ODataListResponseOfComponent'

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

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

#components_get_single_entity_by_assetmodelid_and_entityid_and_tenantid(asset_model_id, entity_id, tenant_id, region, opts = {}) ⇒ Component

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

Parameters:

  • asset_model_id (Integer)
  • entity_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:



539
540
541
542
 
# File 'lib/xbim_aim/api/components_api.rb', line 539

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

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

Get Components 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;Component&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • asset_model_id (Integer)
  • entity_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<(Component, Integer, Hash)>) —

    Component data, response status code and response headers



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
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/xbim_aim/api/components_api.rb', line 554

def components_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: ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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}/Components(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] || 'Component'

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

  new_options = opts.merge(
    :operation => :"ComponentsApi.components_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: ComponentsApi#components_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

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

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

Parameters:

  • asset_model_id (Integer)
  • entity_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:



630
631
632
633
 
# File 'lib/xbim_aim/api/components_api.rb', line 630

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

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

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

Parameters:

  • asset_model_id (Integer)
  • entity_id (Integer)
  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

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

    the optional parameters

Returns:

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

    Entity data, response status code and response headers



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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/xbim_aim/api/components_api.rb', line 644

def components_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: ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_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 ComponentsApi.components_patch_by_assetmodelid_and_entityid_and_tenantid"
  end
  # resource path
  local_var_path = '/{region}/aim/2.0/{tenantId}/Components(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 => :"ComponentsApi.components_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: ComponentsApi#components_patch_by_assetmodelid_and_entityid_and_tenantid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#components_post_by_tenantid(tenant_id, region, component, opts = {}) ⇒ Component

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

Parameters:

  • tenant_id (String) —

    The unique Tenant ID (UUID or Identifier string)

  • region (String) —

    The data center region the data resides in

  • component (ComponentCreate) —

    The entity to post

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

    the optional parameters

Returns:



725
726
727
728
 
# File 'lib/xbim_aim/api/components_api.rb', line 725

def components_post_by_tenantid(tenant_id, region, component, opts = {})
  data, _status_code, _headers = components_post_by_tenantid_with_http_info(tenant_id, region, component, opts)
  data
end

#components_post_by_tenantid_with_http_info(tenant_id, region, component, opts = {}) ⇒ Array<(Component, Integer, Hash)>

Adds a new Component to a model &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Adds a new Component to a model.&lt;br/&gt;Return Type: &lt;b&gt;Component&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

  • component (ComponentCreate) —

    The entity to post

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

    the optional parameters

Returns:

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

    Component data, response status code and response headers



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
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/xbim_aim/api/components_api.rb', line 737

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

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

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

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