Class: Rafflesia::Ontology

Inherits:
Object
  • Object
show all
Defined in:
lib/rafflesia/ontology.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Ontology

Returns a new instance of Ontology.



9
10
11
 
# File 'lib/rafflesia/ontology.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#bindingsList(database: nil, release: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatasetOntologyBindingListData

GET /v1/ontology/bindings

Parameters:

  • database (String, nil) (defaults to: nil) —

    Optional exact dataset repository name.

  • release (String, nil) (defaults to: nil) —

    Optional exact immutable dataset release.

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

    (see Rafflesia::Types::RequestOptions)

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rafflesia/ontology.rb', line 41

def bindingsList(
  database: nil,
  release: nil,
  request_options: {}
)
  params = {
    'database' => database,
    'release' => release
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/bindings',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatasetOntologyBindingListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#connectivityGet(view: 'summary', domain: nil, classification: nil, is_isolated: nil, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyConnectivityData

GET /v1/ontology/connectivity

Parameters:

  • view (Rafflesia::Types::OntologyView, nil) (defaults to: 'summary')
  • domain (String, nil) (defaults to: nil)
  • classification (String, nil) (defaults to: nil)
  • is_isolated (Rafflesia::Types::OntologyIsIsolated, nil) (defaults to: nil)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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
 
# File 'lib/rafflesia/ontology.rb', line 70

def connectivityGet(
  view: 'summary',
  domain: nil,
  classification: nil,
  is_isolated: nil,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'view' => view,
    'domain' => domain,
    'classification' => classification,
    'is_isolated' => is_isolated,
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/connectivity',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyConnectivityData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#connectivityImpact(from_relation:, to_relation:, safety: 'strict', ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyConnectivityImpactData

GET /v1/ontology/connectivity/impact

Parameters:

  • from_relation (String)
  • to_relation (String)
  • safety (Rafflesia::Types::OntologySafety, nil) (defaults to: 'strict')
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/rafflesia/ontology.rb', line 104

def connectivityImpact(
  from_relation:,
  to_relation:,
  safety: 'strict',
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'from_relation' => from_relation,
    'to_relation' => to_relation,
    'safety' => safety,
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/connectivity/impact',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyConnectivityImpactData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#connectivityReadmit(anchors:, base_catalog_digest:, base_ontology_digest:, change_id:, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyConnectivityRebuildData

POST /v1/ontology/connectivity/readmit

Parameters:

  • anchors (Array<Rafflesia::OntologyReadmittedAnchorRequest>, nil)
  • base_catalog_digest (String)
  • base_ontology_digest (String)
  • change_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rafflesia/ontology.rb', line 136

def connectivityReadmit(
  anchors:,
  base_catalog_digest:,
  base_ontology_digest:,
  change_id:,
  request_options: {}
)
  body = {
    'anchors' => anchors,
    'base_catalog_digest' => base_catalog_digest,
    'base_ontology_digest' => base_ontology_digest,
    'change_id' => change_id
  }
  response = @client.request(
    method: :post,
    path: '/v1/ontology/connectivity/readmit',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyConnectivityRebuildData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#connectivityRebuild(base_catalog_digest:, base_ontology_digest:, change_id:, isolation_removals: nil, isolation_upserts: nil, readmitted_anchors: nil, reclassifications: nil, removed_relationship_ids: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyConnectivityRebuildData

POST /v1/ontology/connectivity/rebuild

Parameters:

Returns:



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
 
# File 'lib/rafflesia/ontology.rb', line 172

def connectivityRebuild(
  base_catalog_digest:,
  base_ontology_digest:,
  change_id:,
  isolation_removals: nil,
  isolation_upserts: nil,
  readmitted_anchors: nil,
  reclassifications: nil,
  removed_relationship_ids: nil,
  request_options: {}
)
  body = {
    'base_catalog_digest' => base_catalog_digest,
    'base_ontology_digest' => base_ontology_digest,
    'change_id' => change_id,
    'isolation_removals' => isolation_removals,
    'isolation_upserts' => isolation_upserts,
    'readmitted_anchors' => readmitted_anchors,
    'reclassifications' => reclassifications,
    'removed_relationship_ids' => removed_relationship_ids
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/ontology/connectivity/rebuild',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyConnectivityRebuildData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#contextGet(q: nil, match_mode: 'any', relation: nil, source: nil, evidence: 'cardinality_consistent', safety: 'strict', neighbor_hops: 1, max_relations: 8, max_columns: 24, max_paths: 3, max_path_hops: 4, max_bytes: 32768, include_documents: false, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyContextData

GET /v1/ontology/context

Parameters:

  • q (String, nil) (defaults to: nil)
  • match_mode (Rafflesia::Types::OntologyMatchMode, nil) (defaults to: 'any')
  • relation (Array<String>, nil) (defaults to: nil)
  • source (Array<String>, nil) (defaults to: nil) —

    Exact source binding relation=database,release; repeatable.

  • evidence (Rafflesia::Types::OntologyEvidence, nil) (defaults to: 'cardinality_consistent')
  • safety (Rafflesia::Types::OntologySafety, nil) (defaults to: 'strict')
  • neighbor_hops (Integer, nil) (defaults to: 1)
  • max_relations (Integer, nil) (defaults to: 8)
  • max_columns (Integer, nil) (defaults to: 24)
  • max_paths (Integer, nil) (defaults to: 3)
  • max_path_hops (Integer, nil) (defaults to: 4)
  • max_bytes (Integer, nil) (defaults to: 32768)
  • include_documents (Boolean, nil) (defaults to: false)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/rafflesia/ontology.rb', line 222

def contextGet(
  q: nil,
  match_mode: 'any',
  relation: nil,
  source: nil,
  evidence: 'cardinality_consistent',
  safety: 'strict',
  neighbor_hops: 1,
  max_relations: 8,
  max_columns: 24,
  max_paths: 3,
  max_path_hops: 4,
  max_bytes: 32768,
  include_documents: false,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'q' => q,
    'match_mode' => match_mode,
    'relation' => relation,
    'source' => source,
    'evidence' => evidence,
    'safety' => safety,
    'neighbor_hops' => neighbor_hops,
    'max_relations' => max_relations,
    'max_columns' => max_columns,
    'max_paths' => max_paths,
    'max_path_hops' => max_path_hops,
    'max_bytes' => max_bytes,
    'include_documents' => include_documents,
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/context',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyContextData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#coordinateSystemsList(ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyListData

GET /v1/ontology/coordinate_systems

Parameters:

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/rafflesia/ontology.rb', line 271

def coordinateSystemsList(
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/coordinate_systems',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#coordinateSystemsShow(name:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyData

GET /v1/ontology/coordinate_systems/name

Parameters:

  • name (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/rafflesia/ontology.rb', line 295

def coordinateSystemsShow(
  name:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/coordinate_systems/#{Rafflesia::Util.encode_path(name)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#diffCreate(from_digest: nil, from_snapshot: nil, to_digest: nil, to_snapshot: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyDiffData

POST /v1/ontology/diff

Parameters:

  • from_digest (String, nil) (defaults to: nil)
  • from_snapshot (Rafflesia::OntologySnapshotData, nil) (defaults to: nil)
  • to_digest (String, nil) (defaults to: nil)
  • to_snapshot (Rafflesia::OntologySnapshotData, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/rafflesia/ontology.rb', line 322

def diffCreate(
  from_digest: nil,
  from_snapshot: nil,
  to_digest: nil,
  to_snapshot: nil,
  request_options: {}
)
  body = {
    'from_digest' => from_digest,
    'from_snapshot' => from_snapshot,
    'to_digest' => to_digest,
    'to_snapshot' => to_snapshot
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/ontology/diff',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyDiffData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#entityTypesList(ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyListData

GET /v1/ontology/entity_types

Parameters:

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/rafflesia/ontology.rb', line 351

def entityTypesList(
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/entity_types',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#entityTypesShow(name:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyData

GET /v1/ontology/entity_types/name

Parameters:

  • name (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/rafflesia/ontology.rb', line 375

def entityTypesShow(
  name:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/entity_types/#{Rafflesia::Util.encode_path(name)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#get(ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologySnapshotData

GET /v1/ontology

Parameters:

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rafflesia/ontology.rb', line 17

def get(
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologySnapshotData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#identifierNamespacesList(ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyListData

GET /v1/ontology/identifier_namespaces

Parameters:

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/rafflesia/ontology.rb', line 399

def identifierNamespacesList(
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/identifier_namespaces',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#identifierNamespacesShow(name:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyData

GET /v1/ontology/identifier_namespaces/name

Parameters:

  • name (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/rafflesia/ontology.rb', line 423

def identifierNamespacesShow(
  name:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/identifier_namespaces/#{Rafflesia::Util.encode_path(name)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#onboardingCompile(base_ontology_digest:, dataset_name:, dataset_version:, relations:, isolations: nil, key_families: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyOnboardingCompileData

POST /v1/ontology/onboarding/compile

Parameters:

Returns:



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
 
# File 'lib/rafflesia/ontology.rb', line 452

def onboardingCompile(
  base_ontology_digest:,
  dataset_name:,
  dataset_version:,
  relations:,
  isolations: nil,
  key_families: nil,
  request_options: {}
)
  body = {
    'base_ontology_digest' => base_ontology_digest,
    'dataset_name' => dataset_name,
    'dataset_version' => dataset_version,
    'isolations' => isolations,
    'key_families' => key_families,
    'relations' => relations
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/ontology/onboarding/compile',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyOnboardingCompileData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#pathsList(from_relation:, to_relation:, safety: 'strict', max_hops: 0, limit: 10, cursor: nil, from_database: nil, from_release: nil, to_database: nil, to_release: nil, bridge: nil, source: nil, evidence: 'declared', auto_resolve_bridges: true, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyPathListData

GET /v1/ontology/paths

Parameters:

  • from_relation (String)
  • to_relation (String)
  • safety (Rafflesia::Types::OntologySafety, nil) (defaults to: 'strict')
  • max_hops (Integer, nil) (defaults to: 0) —

    Maximum relationship hops. Zero traverses the complete ontology component.

  • limit (Integer, nil) (defaults to: 10)
  • cursor (String, nil) (defaults to: nil)
  • from_database (String, nil) (defaults to: nil) —

    Required unless evidence=declared with no release pins, which returns the declared (not release-backed) route.

  • from_release (String, nil) (defaults to: nil)
  • to_database (String, nil) (defaults to: nil)
  • to_release (String, nil) (defaults to: nil)
  • bridge (Array<String>, nil) (defaults to: nil)
  • source (Array<String>, nil) (defaults to: nil)
  • evidence (Rafflesia::Types::OntologyEvidence, nil) (defaults to: 'declared')
  • auto_resolve_bridges (Boolean, nil) (defaults to: true) —

    Deterministically pin immutable releases for missing intermediate relations.

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/rafflesia/ontology.rb', line 499

def pathsList(
  from_relation:,
  to_relation:,
  safety: 'strict',
  max_hops: 0,
  limit: 10,
  cursor: nil,
  from_database: nil,
  from_release: nil,
  to_database: nil,
  to_release: nil,
  bridge: nil,
  source: nil,
  evidence: 'declared',
  auto_resolve_bridges: true,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'from_relation' => from_relation,
    'to_relation' => to_relation,
    'safety' => safety,
    'max_hops' => max_hops,
    'limit' => limit,
    'cursor' => cursor,
    'from_database' => from_database,
    'from_release' => from_release,
    'to_database' => to_database,
    'to_release' => to_release,
    'bridge' => bridge,
    'source' => source,
    'evidence' => evidence,
    'auto_resolve_bridges' => auto_resolve_bridges,
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/paths',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyPathListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#relationshipsList(from_relation: nil, to_relation: nil, cardinality: nil, safety: 'strict', key_variant: nil, is_lossy: nil, is_range_mapping: nil, limit: 100, cursor: nil, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyRelationshipListData

GET /v1/ontology/relationships

Parameters:

Returns:



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
 
# File 'lib/rafflesia/ontology.rb', line 640

def relationshipsList(
  from_relation: nil,
  to_relation: nil,
  cardinality: nil,
  safety: 'strict',
  key_variant: nil,
  is_lossy: nil,
  is_range_mapping: nil,
  limit: 100,
  cursor: nil,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'from_relation' => from_relation,
    'to_relation' => to_relation,
    'cardinality' => cardinality,
    'safety' => safety,
    'key_variant' => key_variant,
    'is_lossy' => is_lossy,
    'is_range_mapping' => is_range_mapping,
    'limit' => limit,
    'cursor' => cursor,
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/relationships',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyRelationshipListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#relationshipsShow(relationship:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyRelationshipData

GET /v1/ontology/relationships/relationship

Parameters:

  • relationship (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/rafflesia/ontology.rb', line 682

def relationshipsShow(
  relationship:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/relationships/#{Rafflesia::Util.encode_path(relationship)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyRelationshipData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#relationsList(q: nil, match_mode: 'all', domain: nil, entity_type: nil, column: nil, identifier_namespace: nil, coordinate_system: nil, value_kind: nil, related_to: nil, limit: 100, cursor: nil, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyRelationListData

GET /v1/ontology/relations

Parameters:

  • q (String, nil) (defaults to: nil)
  • match_mode (Rafflesia::Types::OntologyMatchMode, nil) (defaults to: 'all')
  • domain (String, nil) (defaults to: nil)
  • entity_type (String, nil) (defaults to: nil)
  • column (String, nil) (defaults to: nil)
  • identifier_namespace (String, nil) (defaults to: nil)
  • coordinate_system (String, nil) (defaults to: nil)
  • value_kind (String, nil) (defaults to: nil)
  • related_to (String, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: 100)
  • cursor (String, nil) (defaults to: nil)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



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
 
# File 'lib/rafflesia/ontology.rb', line 561

def relationsList(
  q: nil,
  match_mode: 'all',
  domain: nil,
  entity_type: nil,
  column: nil,
  identifier_namespace: nil,
  coordinate_system: nil,
  value_kind: nil,
  related_to: nil,
  limit: 100,
  cursor: nil,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'q' => q,
    'match_mode' => match_mode,
    'domain' => domain,
    'entity_type' => entity_type,
    'column' => column,
    'identifier_namespace' => identifier_namespace,
    'coordinate_system' => coordinate_system,
    'value_kind' => value_kind,
    'related_to' => related_to,
    'limit' => limit,
    'cursor' => cursor,
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/relations',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyRelationListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#relationsShow(relation:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyRelationData

GET /v1/ontology/relations/relation

Parameters:

  • relation (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/rafflesia/ontology.rb', line 607

def relationsShow(
  relation:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/relations/#{Rafflesia::Util.encode_path(relation)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyRelationData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#releaseCoverageGet(database:, release:, domain: nil, relation: nil, empirical_mode: 'bounded', request_options: {}) ⇒ Rafflesia::EnvelopeOntologyReleaseCoverageData

GET /v1/ontology/release-coverage

Parameters:

  • database (String)
  • release (String)
  • domain (Array<String>, nil) (defaults to: nil)
  • relation (Array<String>, nil) (defaults to: nil)
  • empirical_mode (Rafflesia::Types::OntologyEmpiricalMode, nil) (defaults to: 'bounded')
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/rafflesia/ontology.rb', line 710

def releaseCoverageGet(
  database:,
  release:,
  domain: nil,
  relation: nil,
  empirical_mode: 'bounded',
  request_options: {}
)
  params = {
    'database' => database,
    'release' => release,
    'domain' => domain,
    'relation' => relation,
    'empirical_mode' => empirical_mode
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/release-coverage',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyReleaseCoverageData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#snapshotsList(request_options: {}) ⇒ Rafflesia::EnvelopeOntologySnapshotListData

GET /v1/ontology/snapshots

Parameters:

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

    (see Rafflesia::Types::RequestOptions)

Returns:



740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/rafflesia/ontology.rb', line 740

def snapshotsList(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/ontology/snapshots',
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologySnapshotListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#snapshotsShow(ontology_digest:, request_options: {}) ⇒ Rafflesia::EnvelopeOntologySnapshotData

GET /v1/ontology/snapshots/ontology_digest

Parameters:

  • ontology_digest (String)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



756
757
758
759
760
761
762
763
764
765
766
767
768
769
 
# File 'lib/rafflesia/ontology.rb', line 756

def snapshotsShow(
  ontology_digest:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/ontology/snapshots/#{Rafflesia::Util.encode_path(ontology_digest)}",
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologySnapshotData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#unitsList(ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyListData

GET /v1/ontology/units

Parameters:

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
 
# File 'lib/rafflesia/ontology.rb', line 775

def unitsList(
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/units',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#unitsShow(name:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyData

GET /v1/ontology/units/name

Parameters:

  • name (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
 
# File 'lib/rafflesia/ontology.rb', line 799

def unitsShow(
  name:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/units/#{Rafflesia::Util.encode_path(name)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#validationsCreate(snapshot:, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyValidationData

POST /v1/ontology/validations

Parameters:

Returns:



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/rafflesia/ontology.rb', line 823

def validationsCreate(
  snapshot:,
  request_options: {}
)
  body = {
    'snapshot' => snapshot
  }
  response = @client.request(
    method: :post,
    path: '/v1/ontology/validations',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyValidationData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#valueKindsList(ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyListData

GET /v1/ontology/value_kinds

Parameters:

  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
 
# File 'lib/rafflesia/ontology.rb', line 846

def valueKindsList(
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/ontology/value_kinds',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#valueKindsShow(name:, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeOntologyVocabularyData

GET /v1/ontology/value_kinds/name

Parameters:

  • name (String)
  • ontology_digest (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/rafflesia/ontology.rb', line 870

def valueKindsShow(
  name:,
  ontology_digest: nil,
  request_options: {}
)
  params = {
    'ontology_digest' => ontology_digest
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/ontology/value_kinds/#{Rafflesia::Util.encode_path(name)}",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeOntologyVocabularyData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end