Class: XbimAim::ModelMappingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ModelMappingApi

Returns a new instance of ModelMappingApi.



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

def api_client
  @api_client
end

Instance Method Details

#model_mapping_get_by_mappingid_and_tenantid(mapping_id, tenant_id, region, opts = {}) ⇒ ModelMapping

Get a single Mapping by its key <span style=‘font-size: 17px;’>Summary:</span>Get a single Mapping by its key.<br/>Return Type: ModelMapping<br/><br/>

Parameters:

  • mapping_id (String)
  • 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:



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

def model_mapping_get_by_mappingid_and_tenantid(mapping_id, tenant_id, region, opts = {})
  data, _status_code, _headers = model_mapping_get_by_mappingid_and_tenantid_with_http_info(mapping_id, tenant_id, region, opts)
  data
end

#model_mapping_get_by_mappingid_and_tenantid_with_http_info(mapping_id, tenant_id, region, opts = {}) ⇒ Array<(ModelMapping, Integer, Hash)>

Get a single Mapping by its key &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Get a single Mapping by its key.&lt;br/&gt;Return Type: &lt;b&gt;ModelMapping&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;

Parameters:

  • mapping_id (String)
  • 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<(ModelMapping, Integer, Hash)>) —

    ModelMapping 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
 
# File 'lib/xbim_aim/api/model_mapping_api.rb', line 45

def model_mapping_get_by_mappingid_and_tenantid_with_http_info(mapping_id, tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelMappingApi.model_mapping_get_by_mappingid_and_tenantid ...'
  end
  # verify the required parameter 'mapping_id' is set
  if @api_client.config.client_side_validation && mapping_id.nil?
    fail ArgumentError, "Missing the required parameter 'mapping_id' when calling ModelMappingApi.model_mapping_get_by_mappingid_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 ModelMappingApi.model_mapping_get_by_mappingid_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 ModelMappingApi.model_mapping_get_by_mappingid_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}/ModelMapping({MappingId})'.sub('{' + 'MappingId' + '}', CGI.escape(mapping_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] || 'ModelMapping'

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

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

#model_mapping_get_by_tenantid(tenant_id, region, opts = {}) ⇒ ODataListResponseOfModelMapping

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



121
122
123
124
 
# File 'lib/xbim_aim/api/model_mapping_api.rb', line 121

def model_mapping_get_by_tenantid(tenant_id, region, opts = {})
  data, _status_code, _headers = model_mapping_get_by_tenantid_with_http_info(tenant_id, region, opts)
  data
end

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

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



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
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/xbim_aim/api/model_mapping_api.rb', line 139

def model_mapping_get_by_tenantid_with_http_info(tenant_id, region, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelMappingApi.model_mapping_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 ModelMappingApi.model_mapping_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 ModelMappingApi.model_mapping_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}/ModelMapping'.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'])

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

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

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

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

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