Class: CMV4APIClient::GeneralDefinitionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/api/general_definition_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GeneralDefinitionApi

Returns a new instance of GeneralDefinitionApi.



19
20
21
 
# File 'lib/cmv4-openapi-client/api/general_definition_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/cmv4-openapi-client/api/general_definition_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#definition_get(opts = {}) ⇒ ConcreteEnterpriseDefinition

Get Enterprise Definition Gets the Enterprise Definition object

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 26

def definition_get(opts = {})
  data, _status_code, _headers = definition_get_with_http_info(opts)
  data
end

#definition_get_enterprise_configuration(opts = {}) ⇒ EnterpriseConfigurationModified

Get Enterprise Configuration Gets the Enterprise Configuration object

Parameters:

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 82

def definition_get_enterprise_configuration(opts = {})
  data, _status_code, _headers = definition_get_enterprise_configuration_with_http_info(opts)
  data
end

#definition_get_enterprise_configuration_with_http_info(opts = {}) ⇒ Array<(EnterpriseConfigurationModified, Integer, Hash)>

Get Enterprise Configuration Gets the Enterprise Configuration object

Parameters:

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

    the optional parameters

Returns:



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 91

def definition_get_enterprise_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_enterprise_configuration ...'
  end
  # resource path
  local_var_path = '/definition/enterpriseconfiguration'

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'EnterpriseConfigurationModified'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

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

#definition_get_entity(entity_alias, opts = {}) ⇒ EntityDefinition

Get Entity Definition Gets an entities definition

Parameters:

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

    the optional parameters

Returns:



139
140
141
142
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 139

def definition_get_entity(entity_alias, opts = {})
  data, _status_code, _headers = definition_get_entity_with_http_info(entity_alias, opts)
  data
end

#definition_get_entity_with_http_info(entity_alias, opts = {}) ⇒ Array<(EntityDefinition, Integer, Hash)>

Get Entity Definition Gets an entities definition

Parameters:

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

    the optional parameters

Returns:

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

    EntityDefinition data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 149

def definition_get_entity_with_http_info(entity_alias, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_entity ...'
  end
  # resource path
  local_var_path = '/definition/entity/{entityAlias}'.sub('{' + 'entityAlias' + '}', CGI.escape(entity_alias.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'EntityDefinition'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

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

#definition_get_relationship(relationship_alias, opts = {}) ⇒ RelationshipDefinition

Get Relationship Definition Gets a relationships definition

Parameters:

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

    the optional parameters

Returns:



197
198
199
200
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 197

def definition_get_relationship(relationship_alias, opts = {})
  data, _status_code, _headers = definition_get_relationship_with_http_info(relationship_alias, opts)
  data
end

#definition_get_relationship_with_http_info(relationship_alias, opts = {}) ⇒ Array<(RelationshipDefinition, Integer, Hash)>

Get Relationship Definition Gets a relationships definition

Parameters:

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

    the optional parameters

Returns:

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

    RelationshipDefinition data, response status code and response headers



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 207

def definition_get_relationship_with_http_info(relationship_alias, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_relationship ...'
  end
  # resource path
  local_var_path = '/definition/relationship/{relationshipAlias}'.sub('{' + 'relationshipAlias' + '}', CGI.escape(relationship_alias.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'RelationshipDefinition'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

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

#definition_get_stereotypes(scope, opts = {}) ⇒ Array<Stereotype>

Get Stereotypes By Scope Gets a list of Stereotypes by a particular scope

Parameters:

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

    the optional parameters

Returns:



255
256
257
258
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 255

def definition_get_stereotypes(scope, opts = {})
  data, _status_code, _headers = definition_get_stereotypes_with_http_info(scope, opts)
  data
end

#definition_get_stereotypes_with_http_info(scope, opts = {}) ⇒ Array<(Array<Stereotype>, Integer, Hash)>

Get Stereotypes By Scope Gets a list of Stereotypes by a particular scope

Parameters:

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

    the optional parameters

Returns:

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

    Array<Stereotype> data, response status code and response headers



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
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 265

def definition_get_stereotypes_with_http_info(scope, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_stereotypes ...'
  end
  # verify the required parameter 'scope' is set
  if @api_client.config.client_side_validation && scope.nil?
    fail ArgumentError, "Missing the required parameter 'scope' when calling GeneralDefinitionApi.definition_get_stereotypes"
  end
  # resource path
  local_var_path = '/definition/stereotypes/{scope}'.sub('{' + 'scope' + '}', CGI.escape(scope.to_s))

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<Stereotype>'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

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

#definition_get_with_http_info(opts = {}) ⇒ Array<(ConcreteEnterpriseDefinition, Integer, Hash)>

Get Enterprise Definition Gets the Enterprise Definition object

Parameters:

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

    the optional parameters

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cmv4-openapi-client/api/general_definition_api.rb', line 35

def definition_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get ...'
  end
  # resource path
  local_var_path = '/definition/enterprisedefinition'

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

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

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

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

  # return_type
  return_type = opts[:return_type] || 'ConcreteEnterpriseDefinition'

  # auth_names
  auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']

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