openapi.json 708 KB
Newer Older
Jeremie Hallal's avatar
Jeremie Hallal committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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
202
203
204
205
206
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
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
717
718
719
{
  "components": {
    "schemas": {
      "AboutResponse": {
        "properties": {
          "buildNumber": {
            "title": "Buildnumber",
            "type": "string"
          },
          "cloudEnvironment": {
            "title": "Cloudenvironment",
            "type": "string"
          },
          "service": {
            "title": "Service",
            "type": "string"
          },
          "version": {
            "title": "Version",
            "type": "string"
          }
        },
        "title": "AboutResponse",
        "type": "object"
      },
      "AbstractAccessControlList100": {
        "additionalProperties": false,
        "description": "The access control tags associated with this entity.",
        "properties": {
          "owners": {
            "description": "The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).",
            "items": {
              "$ref": "#/components/schemas/Owner"
            },
            "title": "List of Owners",
            "type": "array"
          },
          "viewers": {
            "description": "The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).",
            "items": {
              "$ref": "#/components/schemas/Viewer"
            },
            "title": "List of Viewers",
            "type": "array"
          }
        },
        "required": [
          "owners",
          "viewers"
        ],
        "title": "AbstractAccessControlList100",
        "type": "object"
      },
      "AbstractAliasNames100": {
        "additionalProperties": false,
        "description": "A list of alternative names for an object.  The preferred name is in a separate, scalar property.  It may or may not be repeated in the alias list, though a best practice is to include it if the list is present, but to omit the list if there are no other names.  Note that the abstract entity is an array so the $ref to it is a simple property reference.",
        "properties": {
          "AliasName": {
            "description": "Alternative Name value of defined name type for an object.",
            "title": "Aliasname",
            "type": "string"
          },
          "AliasNameTypeID": {
            "description": "A classification of alias names such as by role played or type of source, such as regulatory name, regulatory code, company code, international standard name, etc.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-AliasNameType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Aliasnametypeid",
            "type": "string"
          },
          "DefinitionOrganisationID": {
            "description": "The StandardsOrganisation (reference-data) or Organisation (master-data) that provided the name (the source).",
            "pattern": "^[\\w\\-\\.]+:(reference-data\\-\\-StandardsOrganisation|master-data\\-\\-Organisation):[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Definitionorganisationid",
            "type": "string"
          },
          "EffectiveDateTime": {
            "description": "The date and time when an alias name becomes effective.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The data and time when an alias name is no longer in effect.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          }
        },
        "title": "AbstractAliasNames100",
        "type": "object"
      },
      "AbstractAnyCrsFeatureCollection100": {
        "additionalProperties": false,
        "description": "The original or 'as ingested' coordinates (Point, MultiPoint, LineString, MultiLineString, Polygon or MultiPolygon). The name 'AsIngestedCoordinates' was chosen to contrast it to 'OriginalCoordinates', which carries the uncertainty whether any coordinate operations took place before ingestion. In cases where the original CRS is different from the as-ingested CRS, the OperationsApplied can also contain the list of operations applied to the coordinate prior to ingestion. The data structure is similar to GeoJSON FeatureCollection, however in a CRS context explicitly defined within the AbstractAnyCrsFeatureCollection. The coordinate sequence follows GeoJSON standard, i.e. 'eastward/longitude', 'northward/latitude' {, 'upward/height' unless overridden by an explicit direction in the AsIngestedCoordinates.VerticalCoordinateReferenceSystemID}.",
        "properties": {
          "CoordinateReferenceSystemID": {
            "description": "The CRS reference into the CoordinateReferenceSystem catalog.",
            "example": "namespace:reference-data--CoordinateReferenceSystem:BoundCRS.SLB.32021.15851:",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-CoordinateReferenceSystem:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Coordinate Reference System ID",
            "type": "string"
          },
          "VerticalCoordinateReferenceSystemID": {
            "description": "The explicit VerticalCRS reference into the CoordinateReferenceSystem catalog. This property stays empty for 2D geometries. Absent or empty values for 3D geometries mean the context may be provided by a CompoundCRS in 'CoordinateReferenceSystemID' or implicitly EPSG:5714 MSL height",
            "example": "namespace:reference-data--CoordinateReferenceSystem:VerticalCRS.EPSG.5773:",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-CoordinateReferenceSystem:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Vertical Coordinate Reference System ID",
            "type": "string"
          },
          "bbox": {
            "items": {
              "type": "number"
            },
            "minItems": 4,
            "title": "Bbox",
            "type": "array"
          },
          "features": {
            "items": {
              "$ref": "#/components/schemas/Feature"
            },
            "title": "Features",
            "type": "array"
          },
          "persistableReferenceCrs": {
            "description": "The CRS reference as persistableReference string. If populated, the CoordinateReferenceSystemID takes precedence.",
            "example": "{\"lateBoundCRS\":{\"wkt\":\"PROJCS[\\\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],PROJECTION[\\\"Lambert_Conformal_Conic\\\"],PARAMETER[\\\"False_Easting\\\",2000000.0],PARAMETER[\\\"False_Northing\\\",0.0],PARAMETER[\\\"Central_Meridian\\\",-100.5],PARAMETER[\\\"Standard_Parallel_1\\\",46.1833333333333],PARAMETER[\\\"Standard_Parallel_2\\\",47.4833333333333],PARAMETER[\\\"Latitude_Of_Origin\\\",45.6666666666667],UNIT[\\\"Foot_US\\\",0.304800609601219],AUTHORITY[\\\"EPSG\\\",32021]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_StatePlane_North_Dakota_South_FIPS_3302\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"32021\"},\"type\":\"LBC\"},\"singleCT\":{\"wkt\":\"GEOGTRAN[\\\"NAD_1927_To_WGS_1984_79_CONUS\\\",GEOGCS[\\\"GCS_North_American_1927\\\",DATUM[\\\"D_North_American_1927\\\",SPHEROID[\\\"Clarke_1866\\\",6378206.4,294.9786982]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],GEOGCS[\\\"GCS_WGS_1984\\\",DATUM[\\\"D_WGS_1984\\\",SPHEROID[\\\"WGS_1984\\\",6378137.0,298.257223563]],PRIMEM[\\\"Greenwich\\\",0.0],UNIT[\\\"Degree\\\",0.0174532925199433]],METHOD[\\\"NADCON\\\"],PARAMETER[\\\"Dataset_conus\\\",0.0],AUTHORITY[\\\"EPSG\\\",15851]]\",\"ver\":\"PE_10_3_1\",\"name\":\"NAD_1927_To_WGS_1984_79_CONUS\",\"authCode\":{\"auth\":\"EPSG\",\"code\":\"15851\"},\"type\":\"ST\"},\"ver\":\"PE_10_3_1\",\"name\":\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\",\"authCode\":{\"auth\":\"SLB\",\"code\":\"32021079\"},\"type\":\"EBC\"}",
            "title": "CRS Reference",
            "type": "string"
          },
          "persistableReferenceUnitZ": {
            "description": "The unit of measure for the Z-axis (only for 3-dimensional coordinates, where the CRS does not describe the vertical unit). Note that the direction is upwards positive, i.e. Z means height.",
            "example": "{\"scaleOffset\":{\"scale\":1.0,\"offset\":0.0},\"symbol\":\"m\",\"baseMeasurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"type\":\"USO\"}",
            "title": "Z-Unit Reference",
            "type": "string"
          },
          "persistableReferenceVerticalCrs": {
            "description": "The VerticalCRS reference as persistableReference string. If populated, the VerticalCoordinateReferenceSystemID takes precedence. The property is null or empty for 2D geometries. For 3D geometries and absent or null persistableReferenceVerticalCrs the vertical CRS is either provided via persistableReferenceCrs's CompoundCRS or it is implicitly defined as EPSG:5714 MSL height.",
            "example": "{\"authCode\":{\"auth\":\"EPSG\",\"code\":\"5773\"},\"type\":\"LBC\",\"ver\":\"PE_10_3_1\",\"name\":\"EGM96_Geoid\",\"wkt\":\"VERTCS[\\\"EGM96_Geoid\\\",VDATUM[\\\"EGM96_Geoid\\\"],PARAMETER[\\\"Vertical_Shift\\\",0.0],PARAMETER[\\\"Direction\\\",1.0],UNIT[\\\"Meter\\\",1.0],AUTHORITY[\\\"EPSG\\\",5773]]\"}",
            "title": "Vertical CRS Reference",
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/app__model__osdu_model__Type"
          }
        },
        "required": [
          "type",
          "persistableReferenceCrs",
          "features"
        ],
        "title": "AbstractAnyCrsFeatureCollection100",
        "type": "object"
      },
      "AbstractFacilityEvent100": {
        "additionalProperties": false,
        "description": "A significant occurrence in the life of a facility, which often changes its state, or the state of one of its components. It can describe a point-in-time (event) or a time interval of a specific type (FacilityEventType).",
        "properties": {
          "EffectiveDateTime": {
            "description": "The date and time at which the event took place or takes effect.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "FacilityEventTypeID": {
            "description": "The facility event type is a picklist. Examples: 'Permit', 'Spud', 'Abandon', etc.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-FacilityEventType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Facilityeventtypeid",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The date and time at which the event is no longer in effect. For point-in-time events the 'TerminationDateTime' must be set equal to 'EffectiveDateTime'. Open time intervals have an absent 'TerminationDateTime'.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          }
        },
        "title": "AbstractFacilityEvent100",
        "type": "object"
      },
      "AbstractFacilityOperator100": {
        "additionalProperties": false,
        "description": "The organisation that was responsible for a facility at some point in time.",
        "properties": {
          "EffectiveDateTime": {
            "description": "The date and time at which the facility operator becomes effective.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "FacilityOperatorID": {
            "description": "Internal, unique identifier for an item 'AbstractFacilityOperator'. This identifier is used by 'AbstractFacility.CurrentOperatorID' and 'AbstractFacility.InitialOperatorID'.",
            "title": "Facility Operator ID",
            "type": "string"
          },
          "FacilityOperatorOrganisationID": {
            "description": "The company that currently operates, or previously operated the facility",
            "pattern": "^[\\w\\-\\.]+:master-data\\-\\-Organisation:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Facilityoperatororganisationid",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The date and time at which the facility operator is no longer in effect. If the operator is still effective, the 'TerminationDateTime' is left absent.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          }
        },
        "title": "AbstractFacilityOperator100",
        "type": "object"
      },
      "AbstractFacilitySpecification100": {
        "additionalProperties": false,
        "description": "A property, characteristic, or attribute about a facility that is not described explicitly elsewhere.",
        "properties": {
          "EffectiveDateTime": {
            "description": "The date and time at which the facility specification instance becomes effective.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "FacilitySpecificationDateTime": {
            "description": "The actual date and time value of the parameter.",
            "format": "date-time",
            "title": "Facilityspecificationdatetime",
            "type": "string"
          },
          "FacilitySpecificationIndicator": {
            "description": "The actual indicator value of the parameter.",
            "title": "Facilityspecificationindicator",
            "type": "boolean"
          },
          "FacilitySpecificationQuantity": {
            "description": "The value for the specified parameter type.",
            "title": "Facilityspecificationquantity",
            "type": "number"
          },
          "FacilitySpecificationText": {
            "description": "The actual text value of the parameter.",
            "title": "Facilityspecificationtext",
            "type": "string"
          },
          "ParameterTypeID": {
            "description": "Parameter type of property or characteristic.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-ParameterType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Parametertypeid",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The date and time at which the facility specification instance is no longer in effect.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          },
          "UnitOfMeasureID": {
            "description": "The unit for the quantity parameter, like metre (m in SI units system) for quantity Length.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-UnitOfMeasure:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Unitofmeasureid",
            "type": "string"
          }
        },
        "title": "AbstractFacilitySpecification100",
        "type": "object"
      },
      "AbstractFacilityState100": {
        "additionalProperties": false,
        "description": "The life cycle status of a facility at some point in time.",
        "properties": {
          "EffectiveDateTime": {
            "description": "The date and time at which the facility state becomes effective.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "FacilityStateTypeID": {
            "description": "The facility life cycle state from planning to abandonment.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-FacilityStateType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Facilitystatetypeid",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The date and time at which the facility state is no longer in effect.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          }
        },
        "title": "AbstractFacilityState100",
        "type": "object"
      },
      "AbstractFacilityVerticalMeasurement100": {
        "additionalProperties": false,
        "description": "A location along a wellbore, _usually_ associated with some aspect of the drilling of the wellbore, but not with any intersecting _subsurface_ natural surfaces.",
        "properties": {
          "EffectiveDateTime": {
            "description": "The date and time at which a vertical measurement instance becomes effective.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The date and time at which a vertical measurement instance is no longer in effect.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          },
          "VerticalCRSID": {
            "description": "A vertical coordinate reference system defines the origin for height or depth values. It is expected that either VerticalCRSID or VerticalReferenceID reference is provided in a given vertical measurement array object, but not both.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-CoordinateReferenceSystem:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Verticalcrsid",
            "type": "string"
          },
          "VerticalMeasurement": {
            "description": "The value of the elevation or depth. Depth is positive downwards from a vertical reference or geodetic datum along a path, which can be vertical; elevation is positive upwards from a geodetic datum along a vertical path. Either can be negative.",
            "title": "Verticalmeasurement",
            "type": "number"
          },
          "VerticalMeasurementDescription": {
            "description": "Text which describes a vertical measurement in detail.",
            "title": "Verticalmeasurementdescription",
            "type": "string"
          },
          "VerticalMeasurementPathID": {
            "description": "Specifies Measured Depth, True Vertical Depth, or Elevation.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-VerticalMeasurementPath:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Verticalmeasurementpathid",
            "type": "string"
          },
          "VerticalMeasurementSourceID": {
            "description": "Specifies Driller vs Logger.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-VerticalMeasurementSource:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Verticalmeasurementsourceid",
            "type": "string"
          },
          "VerticalMeasurementTypeID": {
            "description": "Specifies the type of vertical measurement (TD, Plugback, Kickoff, Drill Floor, Rotary Table...).",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-VerticalMeasurementType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Verticalmeasurementtypeid",
            "type": "string"
          },
          "VerticalMeasurementUnitOfMeasureID": {
            "description": "The unit of measure for the vertical measurement. If a unit of measure and a vertical CRS are provided, the unit of measure provided is taken over the unit of measure from the CRS.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-UnitOfMeasure:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Verticalmeasurementunitofmeasureid",
            "type": "string"
          },
          "VerticalReferenceID": {
            "description": "The reference point from which the relative vertical measurement is made. This is only populated if the measurement has no VerticalCRSID specified. The value entered must be the VerticalMeasurementID for another vertical measurement array element in this resource or its parent facility, and as a chain of measurements, they must resolve ultimately to a Vertical CRS. It is expected that a VerticalCRSID or a VerticalReferenceID is provided in a given vertical measurement array object, but not both.",
            "title": "Verticalreferenceid",
            "type": "string"
          },
          "WellboreTVDTrajectoryID": {
            "description": "Specifies what directional survey or wellpath was used to calculate the TVD.",
            "pattern": "^[\\w\\-\\.]+:work-product-component\\-\\-WellboreTrajectory:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Wellboretvdtrajectoryid",
            "type": "string"
          }
        },
        "title": "AbstractFacilityVerticalMeasurement100",
        "type": "object"
      },
      "AbstractFeatureCollection100": {
        "additionalProperties": false,
        "description": "The normalized coordinates (Point, MultiPoint, LineString, MultiLineString, Polygon or MultiPolygon) based on WGS 84 (EPSG:4326 for 2-dimensional coordinates, EPSG:4326 + EPSG:5714 (MSL) for 3-dimensional coordinates). This derived coordinate representation is intended for global discoverability only. The schema of this substructure is identical to the GeoJSON FeatureCollection https://geojson.org/schema/FeatureCollection.json. The coordinate sequence follows GeoJSON standard, i.e. longitude, latitude {, height}",
        "properties": {
          "bbox": {
            "items": {
              "type": "number"
            },
            "minItems": 4,
            "title": "Bbox",
            "type": "array"
          },
          "features": {
            "items": {
              "$ref": "#/components/schemas/Feature1"
            },
            "title": "Features",
            "type": "array"
          },
          "type": {
            "$ref": "#/components/schemas/Type9"
          }
        },
        "required": [
          "type",
          "features"
        ],
        "title": "AbstractFeatureCollection100",
        "type": "object"
      },
      "AbstractLegalParentList100": {
        "additionalProperties": false,
        "description": "The links to data, which constitute the inputs.",
        "properties": {
          "parents": {
            "description": "An array of none, one or many entity references in the data ecosystem, which identify the source of data in the legal sense. In contract to other relationships, the source record version is required. Example: the 'parents' will be queried when e.g. the subscription of source data services is terminated; access to the derivatives is also terminated.",
            "example": [],
            "items": {
              "$ref": "#/components/schemas/Parent"
            },
            "title": "Parents",
            "type": "array"
          }
        },
        "title": "AbstractLegalParentList100",
        "type": "object"
      },
      "AbstractLegalTags100": {
        "additionalProperties": false,
        "description": "The entity's legal tags and compliance status. The actual contents associated with the legal tags is managed by the Compliance Service.",
        "properties": {
          "legaltags": {
            "description": "The list of legal tags, which resolve to legal properties (like country of origin, export classification code, etc.) and rules with the help of the Compliance Service.",
            "items": {
              "type": "string"
            },
            "title": "Legal Tags",
            "type": "array"
          },
          "otherRelevantDataCountries": {
            "description": "The list of other relevant data countries as an array of two-letter country codes, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.",
            "items": {
              "$ref": "#/components/schemas/OtherRelevantDataCountry"
            },
            "title": "Other Relevant Data Countries",
            "type": "array"
          },
          "status": {
            "description": "The legal status. Set by the system after evaluation against the compliance rules associated with the \"legaltags\" using the Compliance Service.",
            "pattern": "^(compliant|uncompliant)$",
            "title": "Legal Status",
            "type": "string"
          }
        },
        "required": [
          "legaltags",
          "otherRelevantDataCountries"
        ],
        "title": "AbstractLegalTags100",
        "type": "object"
      },
      "AbstractSpatialLocation100": {
        "additionalProperties": false,
        "description": "The spatial location information such as coordinates, CRS information (left empty when not appropriate).",
        "properties": {
          "AppliedOperations": {
            "description": "The audit trail of operations applied to the coordinates from the original state to the current state. The list may contain operations applied prior to ingestion as well as the operations applied to produce the Wgs84Coordinates. The text elements refer to ESRI style CRS and Transformation names, which may have to be translated to EPSG standard names.",
            "example": [
              "conversion from ED_1950_UTM_Zone_31N to GCS_European_1950; 1 points converted",
              "transformation GCS_European_1950 to GCS_WGS_1984 using ED_1950_To_WGS_1984_24; 1 points successfully transformed"
            ],
            "items": {
              "type": "string"
            },
            "title": "Operations Applied",
            "type": "array"
          },
          "AsIngestedCoordinates": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AbstractAnyCrsFeatureCollection100"
              }
            ],
            "description": "The original or 'as ingested' coordinates (Point, MultiPoint, LineString, MultiLineString, Polygon or MultiPolygon). The name 'AsIngestedCoordinates' was chosen to contrast it to 'OriginalCoordinates', which carries the uncertainty whether any coordinate operations took place before ingestion. In cases where the original CRS is different from the as-ingested CRS, the OperationsApplied can also contain the list of operations applied to the coordinate prior to ingestion. The data structure is similar to GeoJSON FeatureCollection, however in a CRS context explicitly defined within the AbstractAnyCrsFeatureCollection. The coordinate sequence follows GeoJSON standard, i.e. 'eastward/longitude', 'northward/latitude' {, 'upward/height' unless overridden by an explicit direction in the AsIngestedCoordinates.VerticalCoordinateReferenceSystemID}.",
            "title": "As Ingested Coordinates"
          },
          "CoordinateQualityCheckDateTime": {
            "description": "The date of the Quality Check.",
            "format": "date-time",
            "title": "Coordinatequalitycheckdatetime",
            "type": "string"
          },
          "CoordinateQualityCheckPerformedBy": {
            "description": "The user who performed the Quality Check.",
            "title": "Coordinatequalitycheckperformedby",
            "type": "string"
          },
          "CoordinateQualityCheckRemarks": {
            "description": "Freetext remarks on Quality Check.",
            "items": {
              "type": "string"
            },
            "title": "Coordinatequalitycheckremarks",
            "type": "array"
          },
          "QualitativeSpatialAccuracyTypeID": {
            "description": "A qualitative description of the quality of a spatial location, e.g. unverifiable, not verified, basic validation.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-QualitativeSpatialAccuracyType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Qualitativespatialaccuracytypeid",
            "type": "string"
          },
          "QuantitativeAccuracyBandID": {
            "description": "An approximate quantitative assessment of the quality of a location (accurate to > 500 m (i.e. not very accurate)), to < 1 m, etc.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-QuantitativeAccuracyBand:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Quantitativeaccuracybandid",
            "type": "string"
          },
          "SpatialGeometryTypeID": {
            "description": "Indicates the expected look of the SpatialParameterType, e.g. Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon. The value constrains the type of geometries in the GeoJSON Wgs84Coordinates and AsIngestedCoordinates.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-SpatialGeometryType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Spatialgeometrytypeid",
            "type": "string"
          },
          "SpatialLocationCoordinatesDate": {
            "description": "Date when coordinates were measured or retrieved.",
            "format": "date-time",
            "title": "Spatiallocationcoordinatesdate",
            "type": "string"
          },
          "SpatialParameterTypeID": {
            "description": "A type of spatial representation of an object, often general (e.g. an Outline, which could be applied to Field, Reservoir, Facility, etc.) or sometimes specific (e.g. Onshore Outline, State Offshore Outline, Federal Offshore Outline, 3 spatial representations that may be used by Countries).",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-SpatialParameterType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Spatialparametertypeid",
            "type": "string"
          },
          "Wgs84Coordinates": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AbstractFeatureCollection100"
              }
            ],
            "description": "The normalized coordinates (Point, MultiPoint, LineString, MultiLineString, Polygon or MultiPolygon) based on WGS 84 (EPSG:4326 for 2-dimensional coordinates, EPSG:4326 + EPSG:5714 (MSL) for 3-dimensional coordinates). This derived coordinate representation is intended for global discoverability only. The schema of this substructure is identical to the GeoJSON FeatureCollection https://geojson.org/schema/FeatureCollection.json. The coordinate sequence follows GeoJSON standard, i.e. longitude, latitude {, height}",
            "title": "WGS 84 Coordinates"
          }
        },
        "title": "AbstractSpatialLocation100",
        "type": "object"
      },
      "AbstractWellboreDrillingReason100": {
        "additionalProperties": false,
        "description": "Purpose for drilling a wellbore, which often is an indication of the level of risk.",
        "properties": {
          "DrillingReasonTypeID": {
            "description": "Identifier of the drilling reason type for the corresponding time period.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-DrillingReasonType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Drillingreasontypeid",
            "type": "string"
          },
          "EffectiveDateTime": {
            "description": "The date and time at which the event becomes effective.",
            "format": "date-time",
            "title": "Effectivedatetime",
            "type": "string"
          },
          "TerminationDateTime": {
            "description": "The date and time at which the event is no longer in effect.",
            "format": "date-time",
            "title": "Terminationdatetime",
            "type": "string"
          }
        },
        "title": "AbstractWellboreDrillingReason100",
        "type": "object"
      },
      "AggregationResponse": {
        "properties": {
          "count": {
            "title": "Count",
            "type": "integer"
          },
          "key": {
            "title": "Key",
            "type": "string"
          }
        },
        "title": "AggregationResponse",
        "type": "object"
      },
      "Artefact": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "properties": {
          "ResourceID": {
            "description": "The SRN which identifies this OSDU Artefact resource.",
            "pattern": "^[\\w\\-\\.]+:dataset\\-\\-[\\w\\-\\.]+:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Resourceid",
            "type": "string"
          },
          "ResourceKind": {
            "description": "The kind or schema ID of the artefact. Resolvable with the Schema Service.",
            "pattern": "^[\\w\\-\\.]+:[\\w\\-\\.]+:[\\w\\-\\.]+:[0-9]+.[0-9]+.[0-9]+$",
            "title": "Resourcekind",
            "type": "string"
          },
          "RoleID": {
            "description": "The SRN of this artefact's role.",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-ArtefactRole:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Roleid",
            "type": "string"
          }
        },
        "title": "Artefact",
        "type": "object"
      },
      "AvailableTrajectoryStationProperty": {
        "additionalProperties": false,
        "description": "A set of properties describing a trajectory station property which is available for this instance of a WellboreTrajectory.",
        "properties": {
          "Name": {
            "description": "The name of the curve (e.g. column in a CSV document) as originally found. If absent The name of the TrajectoryCurveType is intended to be used.",
            "example": "AzimuthTN",
            "title": "Name",
            "type": "string"
          },
          "StationPropertyUnitID": {
            "description": "Unit of Measure for the station properties of type TrajectoryStationPropertyType.",
            "example": "partition-id:reference-data--UnitOfMeasure:dega:",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-UnitOfMeasure:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Station Property Unit ID",
            "type": "string"
          },
          "TrajectoryStationPropertyTypeID": {
            "description": "The reference to a trajectory station property type - of if interpreted as channels, the curve or channel name type, identifying e.g. MD, Inclination, Azimuth. This is a relationship to a reference-data--TrajectoryStationPropertyType record id.",
            "example": "partition-id:reference-data--TrajectoryStationPropertyType:AzimuthTN:",
            "pattern": "^[\\w\\-\\.]+:reference-data\\-\\-TrajectoryStationPropertyType:[\\w\\-\\.\\:\\%]+:[0-9]*$",
            "title": "Trajectory Station Property Type ID",
            "type": "string"
          }
        },
        "title": "AvailableTrajectoryStationProperty",
        "type": "object"
      },
      "Body_fastquery_wellbores_bygeopolygon_ddms_fastquery_wellbores_bygeopolygon_post": {
        "properties": {
          "points": {
            "items": {
              "$ref": "#/components/schemas/Point"
            },
            "title": "Points",
            "type": "array"
          },
          "query": {
            "$ref": "#/components/schemas/SearchQuery"
          }
        },
        "required": [
          "points"
        ],
        "title": "Body_fastquery_wellbores_bygeopolygon_ddms_fastquery_wellbores_bygeopolygon_post",
        "type": "object"
      },
      "Body_query_wellbores_bygeopolygon_ddms_query_wellbores_bygeopolygon_post": {
        "properties": {
          "points": {
            "items": {
              "$ref": "#/components/schemas/Point"
            },
            "title": "Points",
            "type": "array"
          },
          "query": {
            "$ref": "#/components/schemas/SearchQuery"
          }
        },
        "required": [
          "points"
        ],
        "title": "Body_query_wellbores_bygeopolygon_ddms_query_wellbores_bygeopolygon_post",
        "type": "object"
      },
      "Body_upload_log_data_file_ddms_v2_logs__logid__upload_data_post": {
        "properties": {
          "file": {
            "format": "binary",
            "title": "File",
            "type": "string"
          }
        },
        "required": [
          "file"
        ],
        "title": "Body_upload_log_data_file_ddms_v2_logs__logid__upload_data_post",
        "type": "object"
      },
      "ByBoundingBox": {
        "properties": {
          "bottomRight": {
            "$ref": "#/components/schemas/Point"
          },
          "topLeft": {
            "$ref": "#/components/schemas/Point"
          }
        },
        "required": [
          "topLeft",
          "bottomRight"
        ],
        "title": "ByBoundingBox",
        "type": "object"
      },
      "ByDistance": {
        "properties": {
          "distance": {
            "title": "Distance",
            "type": "number"
          },
          "point": {
            "$ref": "#/components/schemas/Point"
          }
        },
        "required": [
          "point"
        ],
        "title": "ByDistance",
        "type": "object"
      },
      "ByGeoPolygon": {
        "properties": {
          "points": {
            "items": {
              "$ref": "#/components/schemas/Point"
            },
            "title": "Points",
            "type": "array"
          }
        },
        "title": "ByGeoPolygon",
        "type": "object"
      },
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
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
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
      "Catalog": {
        "properties": {
          "family_catalog": {
            "items": {
              "$ref": "#/components/schemas/CatalogItem"
            },
            "title": "Family Catalog",
            "type": "array"
          },
          "main_family_catalog": {
            "items": {
              "$ref": "#/components/schemas/MainFamilyCatalogItem"
            },
            "title": "Main Family Catalog",
            "type": "array"
          }
        },
        "required": [
          "family_catalog"
        ],
        "title": "Catalog",
        "type": "object"
      },
      "CatalogItem": {
        "properties": {
          "family": {
            "default": "",
            "title": "Family",
            "type": "string"
          },
          "rule": {
            "title": "Rule",
            "type": "string"
          },
          "unit": {
            "title": "Unit",
            "type": "string"
          }
        },
        "required": [
          "unit",
          "rule"
        ],
        "title": "CatalogItem",
        "type": "object"
      },
      "CatalogRecord": {
        "example": {
          "acl": {
            "owners": [
              "abc@domain.com, cde@domain.com"
            ],
            "viewers": [
              "abc@domain.com, cde@domain.com"
            ]
          },
          "data": {
            "family_catalog": [
              {
                "family": "Medium Resistivity",
                "rule": "MEDR",
                "unit": "ohm.m"
              }
            ],
            "main_family_catalog": [
              {
                "Family": "Medium Resistivity",
                "MainFamily": "Resistivity",
                "Unit": "OHMM"
              }
            ]
          },
          "legal": {
            "legaltags": [
              "opendes-public-usa-dataset-1"
            ],
            "otherRelevantDataCountries": [
              "US"
            ]
          }
        },
        "properties": {
          "acl": {
            "$ref": "#/components/schemas/StorageAcl"
          },
          "data": {
            "$ref": "#/components/schemas/Catalog"
          },
          "legal": {
            "$ref": "#/components/schemas/odes_storage__models__Legal"
          }
        },
        "required": [
          "acl",
          "legal",
          "data"
        ],
        "title": "CatalogRecord",
        "type": "object"
      },
Jeremie Hallal's avatar
Jeremie Hallal committed
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
      "Coordinate": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate",
        "type": "array"
      },
      "Coordinate1": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate1",
        "type": "array"
      },
      "Coordinate2": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate2",
        "type": "array"
      },
      "Coordinate3": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate3",
        "type": "array"
      },
      "Coordinate4": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate4",
        "type": "array"
      },
      "Coordinate5": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate5",
        "type": "array"
      },
      "Coordinate6": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate6",
        "type": "array"
      },
      "Coordinate7": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate7",
        "type": "array"
      },
      "Coordinate8": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate8",
        "type": "array"
      },
      "Coordinate9": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "items": {},
        "title": "Coordinate9",
        "type": "array"
      },
      "CreateDataSessionRequest": {
        "description": "Note:\nif fromVersion is provided, should we:\n    force mode to 'update'\n    raise an error if mode is overwrite",
        "properties": {
          "fromVersion": {
            "default": 0,
            "description": "specify the version on top of which update will be applied. By default use the latest one (0). Not relevant if overwrite is set to True.",
            "title": "Fromversion",
            "type": "integer"
          },
          "meta": {
            "additionalProperties": {
              "type": "string"
            },
            "description": "dictionary all values, stored in the session",
            "title": "Meta",
            "type": "object"
          },
          "mode": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SessionUpdateMode"
              }
            ],
            "description": "merge mode at commit. If 'update', existing data will be merged with the data sent during the session. If 'overwrite', existing data will be ignored, the final result will only contains data sent within the session."
          },
          "timeToLive": {
            "default": 1440,
            "description": "optional - time to live in minutes.",
            "title": "Timetolive",
            "type": "integer"
          }
        },
        "required": [
          "mode"
        ],
        "title": "CreateDataSessionRequest",
        "type": "object"
      },
      "CreateUpdateRecordsResponse": {
        "properties": {
          "recordCount": {
            "title": "Recordcount",
            "type": "integer"
          },
          "recordIdVersions": {
            "items": {
              "type": "string"
            },
            "title": "Recordidversions",
            "type": "array"
          },
          "recordIds": {
            "items": {
              "type": "string"
            },
            "title": "Recordids",
            "type": "array"
          },
          "skippedRecordIds": {
            "items": {
              "type": "string"
            },
            "title": "Skippedrecordids",
            "type": "array"
          }
        },
        "title": "CreateUpdateRecordsResponse",
        "type": "object"
      },
      "CursorQueryResponse": {
        "properties": {
          "cursor": {
            "title": "Cursor",
            "type": "string"
          },
          "results": {
            "items": {
              "type": "object"
            },
            "title": "Results",
            "type": "array"
          },
          "totalCount": {
            "title": "Totalcount",
            "type": "integer"
          }
        },
        "title": "CursorQueryResponse",
        "type": "object"
      },
      "Curve110": {
        "additionalProperties": false,
        "description": "The base model forbids fields which are not declared initially in the pydantic model",
        "properties": {
          "BaseDepth": {
            "description": "DEPRECATED: populate data.SamplingStart or data.SamplingStop instead, for informational purposes data.BottomMeasuredDepth. SamplingStart and SamplingStop support other domains than depth.",
            "title": "Basedepth",
            "type": "number"
          },
          "CurveID": {
            "description": "The ID of the Well Log Curve",
            "title": "Curveid",
            "type": "string"
          },
          "CurveQuality": {
            "description": "The Quality of the Log Curve.",
            "title": "Curvequality",
            "type": "string"
          },
          "CurveUnit": {
            "description": "Unit of Measure for the Log Curve",
For faster browsing, not all history is shown. View entire blame