@osdk/internal.foundry.ontologies 2.12.0 → 2.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/build/browser/_components.d.ts +3641 -0
  3. package/build/browser/_components.d.ts.map +1 -1
  4. package/build/browser/_errors.d.ts +1394 -0
  5. package/build/browser/_errors.d.ts.map +1 -1
  6. package/build/browser/index.d.ts +2 -2
  7. package/build/browser/index.d.ts.map +1 -1
  8. package/build/browser/public/Action.d.ts +20 -19
  9. package/build/browser/public/Action.d.ts.map +1 -1
  10. package/build/browser/public/ActionType.d.ts +6 -5
  11. package/build/browser/public/ActionType.d.ts.map +1 -1
  12. package/build/browser/public/Attachment.d.ts +4 -3
  13. package/build/browser/public/Attachment.d.ts.map +1 -1
  14. package/build/browser/public/ObjectType.d.ts +14 -10
  15. package/build/browser/public/ObjectType.d.ts.map +1 -1
  16. package/build/browser/public/Ontology.d.ts +3 -3
  17. package/build/browser/public/Ontology.d.ts.map +1 -1
  18. package/build/browser/public/OntologyObject.d.ts +33 -32
  19. package/build/browser/public/OntologyObject.d.ts.map +1 -1
  20. package/build/browser/public/Query.d.ts +5 -5
  21. package/build/browser/public/Query.d.ts.map +1 -1
  22. package/build/browser/public/QueryType.d.ts +7 -3
  23. package/build/browser/public/QueryType.d.ts.map +1 -1
  24. package/build/esm/_components.d.ts +3641 -0
  25. package/build/esm/_components.d.ts.map +1 -1
  26. package/build/esm/_errors.d.ts +1394 -0
  27. package/build/esm/_errors.d.ts.map +1 -1
  28. package/build/esm/index.d.ts +2 -2
  29. package/build/esm/index.d.ts.map +1 -1
  30. package/build/esm/public/Action.d.ts +20 -19
  31. package/build/esm/public/Action.d.ts.map +1 -1
  32. package/build/esm/public/ActionType.d.ts +6 -5
  33. package/build/esm/public/ActionType.d.ts.map +1 -1
  34. package/build/esm/public/Attachment.d.ts +4 -3
  35. package/build/esm/public/Attachment.d.ts.map +1 -1
  36. package/build/esm/public/ObjectType.d.ts +14 -10
  37. package/build/esm/public/ObjectType.d.ts.map +1 -1
  38. package/build/esm/public/Ontology.d.ts +3 -3
  39. package/build/esm/public/Ontology.d.ts.map +1 -1
  40. package/build/esm/public/OntologyObject.d.ts +33 -32
  41. package/build/esm/public/OntologyObject.d.ts.map +1 -1
  42. package/build/esm/public/Query.d.ts +5 -5
  43. package/build/esm/public/Query.d.ts.map +1 -1
  44. package/build/esm/public/QueryType.d.ts +7 -3
  45. package/build/esm/public/QueryType.d.ts.map +1 -1
  46. package/package.json +4 -3
@@ -1,4 +1,3645 @@
1
+ import type * as _Core from "@osdk/internal.foundry.core";
2
+ import type * as _Geo from "@osdk/internal.foundry.geo";
1
3
  export type LooselyBrandedString<T extends string> = string & {
2
4
  __LOOSE_BRAND?: T;
3
5
  };
6
+ /**
7
+ * ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.
8
+ *
9
+ * Log Safety: UNSAFE
10
+ */
11
+ export interface AbsoluteTimeRange {
12
+ startTime?: string;
13
+ endTime?: string;
14
+ }
15
+ /**
16
+ * Log Safety: UNSAFE
17
+ */
18
+ export type Action = LooselyBrandedString<"Action">;
19
+ /**
20
+ * Log Safety: SAFE
21
+ */
22
+ export type ActionMode = "ASYNC" | "RUN" | "VALIDATE";
23
+ /**
24
+ * Log Safety: UNSAFE
25
+ */
26
+ export interface ActionParameterArrayType {
27
+ subType: ActionParameterType;
28
+ }
29
+ /**
30
+ * A union of all the types supported by Ontology Action parameters.
31
+ *
32
+ * Log Safety: UNSAFE
33
+ */
34
+ export type ActionParameterType = ({
35
+ type: "date";
36
+ } & _Core.DateType) | ({
37
+ type: "interfaceObject";
38
+ } & OntologyInterfaceObjectType) | ({
39
+ type: "struct";
40
+ } & OntologyStructType) | ({
41
+ type: "string";
42
+ } & _Core.StringType) | ({
43
+ type: "double";
44
+ } & _Core.DoubleType) | ({
45
+ type: "integer";
46
+ } & _Core.IntegerType) | ({
47
+ type: "long";
48
+ } & _Core.LongType) | ({
49
+ type: "objectType";
50
+ } & OntologyObjectTypeReferenceType) | ({
51
+ type: "boolean";
52
+ } & _Core.BooleanType) | ({
53
+ type: "marking";
54
+ } & _Core.MarkingType) | ({
55
+ type: "attachment";
56
+ } & _Core.AttachmentType) | ({
57
+ type: "mediaReference";
58
+ } & _Core.MediaReferenceType) | ({
59
+ type: "array";
60
+ } & ActionParameterArrayType) | ({
61
+ type: "objectSet";
62
+ } & OntologyObjectSetType) | ({
63
+ type: "object";
64
+ } & OntologyObjectType) | ({
65
+ type: "timestamp";
66
+ } & _Core.TimestampType);
67
+ /**
68
+ * Details about a parameter of an action.
69
+ *
70
+ * Log Safety: UNSAFE
71
+ */
72
+ export interface ActionParameterV2 {
73
+ description?: string;
74
+ dataType: ActionParameterType;
75
+ required: boolean;
76
+ }
77
+ /**
78
+ * Log Safety: UNSAFE
79
+ */
80
+ export type ActionResults = ({
81
+ type: "edits";
82
+ } & ObjectEdits) | ({
83
+ type: "largeScaleEdits";
84
+ } & ObjectTypeEdits);
85
+ /**
86
+ * The unique resource identifier for an action.
87
+ *
88
+ * Log Safety: SAFE
89
+ */
90
+ export type ActionRid = LooselyBrandedString<"ActionRid">;
91
+ /**
92
+ * Represents an action type in the Ontology.
93
+ *
94
+ * Log Safety: UNSAFE
95
+ */
96
+ export interface ActionType {
97
+ apiName: ActionTypeApiName;
98
+ description?: string;
99
+ displayName?: _Core.DisplayName;
100
+ status: _Core.ReleaseStatus;
101
+ parameters: Record<ParameterId, Parameter>;
102
+ rid: ActionTypeRid;
103
+ operations: Array<LogicRule>;
104
+ }
105
+ /**
106
+ * The name of the action type in the API. To find the API name for your Action Type, use the List action types
107
+ endpoint or check the Ontology Manager.
108
+ *
109
+ * Log Safety: UNSAFE
110
+ */
111
+ export type ActionTypeApiName = LooselyBrandedString<"ActionTypeApiName">;
112
+ /**
113
+ * The unique resource identifier of an action type, useful for interacting with other Foundry APIs.
114
+ *
115
+ * Log Safety: SAFE
116
+ */
117
+ export type ActionTypeRid = LooselyBrandedString<"ActionTypeRid">;
118
+ /**
119
+ * Represents an action type in the Ontology.
120
+ *
121
+ * Log Safety: UNSAFE
122
+ */
123
+ export interface ActionTypeV2 {
124
+ apiName: ActionTypeApiName;
125
+ description?: string;
126
+ displayName?: _Core.DisplayName;
127
+ status: _Core.ReleaseStatus;
128
+ parameters: Record<ParameterId, ActionParameterV2>;
129
+ rid: ActionTypeRid;
130
+ operations: Array<LogicRule>;
131
+ }
132
+ /**
133
+ * This status indicates that the PropertyType will not change on short notice and should thus be safe to use in
134
+ user facing workflows.
135
+ *
136
+ * Log Safety: SAFE
137
+ */
138
+ export interface ActivePropertyTypeStatus {
139
+ }
140
+ /**
141
+ * Log Safety: UNSAFE
142
+ */
143
+ export interface AddLink {
144
+ linkTypeApiNameAtoB: LinkTypeApiName;
145
+ linkTypeApiNameBtoA: LinkTypeApiName;
146
+ aSideObject: LinkSideObject;
147
+ bSideObject: LinkSideObject;
148
+ }
149
+ /**
150
+ * Log Safety: UNSAFE
151
+ */
152
+ export interface AddObject {
153
+ primaryKey: PropertyValue;
154
+ objectType: ObjectTypeApiName;
155
+ }
156
+ /**
157
+ * Log Safety: UNSAFE
158
+ */
159
+ export interface AggregateObjectSetRequestV2 {
160
+ aggregation: Array<AggregationV2>;
161
+ objectSet: ObjectSet;
162
+ groupBy: Array<AggregationGroupByV2>;
163
+ accuracy?: AggregationAccuracyRequest;
164
+ }
165
+ /**
166
+ * Log Safety: UNSAFE
167
+ */
168
+ export interface AggregateObjectsRequest {
169
+ aggregation: Array<Aggregation>;
170
+ query?: SearchJsonQuery;
171
+ groupBy: Array<AggregationGroupBy>;
172
+ }
173
+ /**
174
+ * Log Safety: UNSAFE
175
+ */
176
+ export interface AggregateObjectsRequestV2 {
177
+ aggregation: Array<AggregationV2>;
178
+ where?: SearchJsonQueryV2;
179
+ groupBy: Array<AggregationGroupByV2>;
180
+ accuracy?: AggregationAccuracyRequest;
181
+ }
182
+ /**
183
+ * Log Safety: UNSAFE
184
+ */
185
+ export interface AggregateObjectsResponse {
186
+ excludedItems?: number;
187
+ nextPageToken?: _Core.PageToken;
188
+ data: Array<AggregateObjectsResponseItem>;
189
+ }
190
+ /**
191
+ * Log Safety: UNSAFE
192
+ */
193
+ export interface AggregateObjectsResponseItem {
194
+ group: Record<AggregationGroupKey, AggregationGroupValue>;
195
+ metrics: Array<AggregationMetricResult>;
196
+ }
197
+ /**
198
+ * Log Safety: UNSAFE
199
+ */
200
+ export interface AggregateObjectsResponseItemV2 {
201
+ group: Record<AggregationGroupKeyV2, AggregationGroupValueV2>;
202
+ metrics: Array<AggregationMetricResultV2>;
203
+ }
204
+ /**
205
+ * Log Safety: UNSAFE
206
+ */
207
+ export interface AggregateObjectsResponseV2 {
208
+ excludedItems?: number;
209
+ accuracy: AggregationAccuracy;
210
+ data: Array<AggregateObjectsResponseItemV2>;
211
+ }
212
+ /**
213
+ * Specifies an aggregation function.
214
+ *
215
+ * Log Safety: UNSAFE
216
+ */
217
+ export type Aggregation = ({
218
+ type: "approximateDistinct";
219
+ } & ApproximateDistinctAggregation) | ({
220
+ type: "min";
221
+ } & MinAggregation) | ({
222
+ type: "avg";
223
+ } & AvgAggregation) | ({
224
+ type: "max";
225
+ } & MaxAggregation) | ({
226
+ type: "count";
227
+ } & CountAggregation) | ({
228
+ type: "sum";
229
+ } & SumAggregation);
230
+ /**
231
+ * Log Safety: SAFE
232
+ */
233
+ export type AggregationAccuracy = "ACCURATE" | "APPROXIMATE";
234
+ /**
235
+ * Log Safety: SAFE
236
+ */
237
+ export type AggregationAccuracyRequest = "REQUIRE_ACCURATE" | "ALLOW_APPROXIMATE";
238
+ /**
239
+ * Divides objects into groups according to an interval. Note that this grouping applies only on date types.
240
+ The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds.
241
+ *
242
+ * Log Safety: UNSAFE
243
+ */
244
+ export interface AggregationDurationGrouping {
245
+ field: FieldNameV1;
246
+ duration: Duration;
247
+ }
248
+ /**
249
+ * Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.
250
+ When grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.
251
+ *
252
+ * Log Safety: UNSAFE
253
+ */
254
+ export interface AggregationDurationGroupingV2 {
255
+ field: PropertyApiName;
256
+ value: number;
257
+ unit: TimeUnit;
258
+ }
259
+ /**
260
+ * Divides objects into groups according to an exact value.
261
+ *
262
+ * Log Safety: UNSAFE
263
+ */
264
+ export interface AggregationExactGrouping {
265
+ field: FieldNameV1;
266
+ maxGroupCount?: number;
267
+ }
268
+ /**
269
+ * Divides objects into groups according to an exact value.
270
+ *
271
+ * Log Safety: UNSAFE
272
+ */
273
+ export interface AggregationExactGroupingV2 {
274
+ field: PropertyApiName;
275
+ maxGroupCount?: number;
276
+ defaultValue?: string;
277
+ }
278
+ /**
279
+ * Divides objects into groups with the specified width.
280
+ *
281
+ * Log Safety: UNSAFE
282
+ */
283
+ export interface AggregationFixedWidthGrouping {
284
+ field: FieldNameV1;
285
+ fixedWidth: number;
286
+ }
287
+ /**
288
+ * Divides objects into groups with the specified width.
289
+ *
290
+ * Log Safety: UNSAFE
291
+ */
292
+ export interface AggregationFixedWidthGroupingV2 {
293
+ field: PropertyApiName;
294
+ fixedWidth: number;
295
+ }
296
+ /**
297
+ * Specifies a grouping for aggregation results.
298
+ *
299
+ * Log Safety: UNSAFE
300
+ */
301
+ export type AggregationGroupBy = ({
302
+ type: "duration";
303
+ } & AggregationDurationGrouping) | ({
304
+ type: "fixedWidth";
305
+ } & AggregationFixedWidthGrouping) | ({
306
+ type: "ranges";
307
+ } & AggregationRangesGrouping) | ({
308
+ type: "exact";
309
+ } & AggregationExactGrouping);
310
+ /**
311
+ * Specifies a grouping for aggregation results.
312
+ *
313
+ * Log Safety: UNSAFE
314
+ */
315
+ export type AggregationGroupByV2 = ({
316
+ type: "duration";
317
+ } & AggregationDurationGroupingV2) | ({
318
+ type: "fixedWidth";
319
+ } & AggregationFixedWidthGroupingV2) | ({
320
+ type: "ranges";
321
+ } & AggregationRangesGroupingV2) | ({
322
+ type: "exact";
323
+ } & AggregationExactGroupingV2);
324
+ /**
325
+ * Log Safety: UNSAFE
326
+ */
327
+ export type AggregationGroupKey = LooselyBrandedString<"AggregationGroupKey">;
328
+ /**
329
+ * Log Safety: UNSAFE
330
+ */
331
+ export type AggregationGroupKeyV2 = LooselyBrandedString<"AggregationGroupKeyV2">;
332
+ /**
333
+ * Log Safety: UNSAFE
334
+ */
335
+ export type AggregationGroupValue = any;
336
+ /**
337
+ * Log Safety: UNSAFE
338
+ */
339
+ export type AggregationGroupValueV2 = any;
340
+ /**
341
+ * A user-specified alias for an aggregation metric name.
342
+ *
343
+ * Log Safety: UNSAFE
344
+ */
345
+ export type AggregationMetricName = LooselyBrandedString<"AggregationMetricName">;
346
+ /**
347
+ * Log Safety: UNSAFE
348
+ */
349
+ export interface AggregationMetricResult {
350
+ name: string;
351
+ value?: number;
352
+ }
353
+ /**
354
+ * Log Safety: UNSAFE
355
+ */
356
+ export interface AggregationMetricResultV2 {
357
+ name: string;
358
+ value?: any;
359
+ }
360
+ /**
361
+ * Divides objects into groups based on their object type. This grouping is only useful when aggregating across
362
+ multiple object types, such as when aggregating over an interface type.
363
+ *
364
+ * Log Safety: SAFE
365
+ */
366
+ export interface AggregationObjectTypeGrouping {
367
+ }
368
+ /**
369
+ * Log Safety: UNSAFE
370
+ */
371
+ export interface AggregationOrderBy {
372
+ metricName: string;
373
+ }
374
+ /**
375
+ * Specifies a date range from an inclusive start date to an exclusive end date.
376
+ *
377
+ * Log Safety: UNSAFE
378
+ */
379
+ export interface AggregationRange {
380
+ lt?: any;
381
+ lte?: any;
382
+ gt?: any;
383
+ gte?: any;
384
+ }
385
+ /**
386
+ * Divides objects into groups according to specified ranges.
387
+ *
388
+ * Log Safety: UNSAFE
389
+ */
390
+ export interface AggregationRangesGrouping {
391
+ field: FieldNameV1;
392
+ ranges: Array<AggregationRange>;
393
+ }
394
+ /**
395
+ * Divides objects into groups according to specified ranges.
396
+ *
397
+ * Log Safety: UNSAFE
398
+ */
399
+ export interface AggregationRangesGroupingV2 {
400
+ field: PropertyApiName;
401
+ ranges: Array<AggregationRangeV2>;
402
+ }
403
+ /**
404
+ * Specifies a range from an inclusive start value to an exclusive end value.
405
+ *
406
+ * Log Safety: UNSAFE
407
+ */
408
+ export interface AggregationRangeV2 {
409
+ startValue: any;
410
+ endValue: any;
411
+ }
412
+ /**
413
+ * Specifies an aggregation function.
414
+ *
415
+ * Log Safety: UNSAFE
416
+ */
417
+ export type AggregationV2 = ({
418
+ type: "approximateDistinct";
419
+ } & ApproximateDistinctAggregationV2) | ({
420
+ type: "min";
421
+ } & MinAggregationV2) | ({
422
+ type: "avg";
423
+ } & AvgAggregationV2) | ({
424
+ type: "max";
425
+ } & MaxAggregationV2) | ({
426
+ type: "approximatePercentile";
427
+ } & ApproximatePercentileAggregationV2) | ({
428
+ type: "count";
429
+ } & CountAggregationV2) | ({
430
+ type: "sum";
431
+ } & SumAggregationV2) | ({
432
+ type: "exactDistinct";
433
+ } & ExactDistinctAggregationV2);
434
+ /**
435
+ * Returns objects where the specified field contains all of the whitespace separated words in any
436
+ order in the provided value. This query supports fuzzy matching.
437
+ *
438
+ * Log Safety: UNSAFE
439
+ */
440
+ export interface AllTermsQuery {
441
+ field: FieldNameV1;
442
+ value: string;
443
+ fuzzy?: Fuzzy;
444
+ }
445
+ /**
446
+ * Returns objects where every query is satisfied.
447
+ *
448
+ * Log Safety: UNSAFE
449
+ */
450
+ export interface AndQuery {
451
+ value: Array<SearchJsonQuery>;
452
+ }
453
+ /**
454
+ * Returns objects where every query is satisfied.
455
+ *
456
+ * Log Safety: UNSAFE
457
+ */
458
+ export interface AndQueryV2 {
459
+ value: Array<SearchJsonQueryV2>;
460
+ }
461
+ /**
462
+ * Returns objects where the specified field contains any of the whitespace separated words in any
463
+ order in the provided value. This query supports fuzzy matching.
464
+ *
465
+ * Log Safety: UNSAFE
466
+ */
467
+ export interface AnyTermQuery {
468
+ field: FieldNameV1;
469
+ value: string;
470
+ fuzzy?: Fuzzy;
471
+ }
472
+ /**
473
+ * Log Safety: SAFE
474
+ */
475
+ export type ApplyActionMode = "VALIDATE_ONLY" | "VALIDATE_AND_EXECUTE";
476
+ /**
477
+ * Log Safety: UNSAFE
478
+ */
479
+ export interface ApplyActionRequest {
480
+ parameters: Record<ParameterId, DataValue | undefined>;
481
+ }
482
+ /**
483
+ * Log Safety: SAFE
484
+ */
485
+ export interface ApplyActionRequestOptions {
486
+ mode?: ApplyActionMode;
487
+ returnEdits?: ReturnEditsMode;
488
+ }
489
+ /**
490
+ * Log Safety: UNSAFE
491
+ */
492
+ export interface ApplyActionRequestV2 {
493
+ options?: ApplyActionRequestOptions;
494
+ parameters: Record<ParameterId, DataValue | undefined>;
495
+ }
496
+ /**
497
+ * Log Safety: SAFE
498
+ */
499
+ export interface ApplyActionResponse {
500
+ }
501
+ /**
502
+ * Computes an approximate number of distinct values for the provided field.
503
+ *
504
+ * Log Safety: UNSAFE
505
+ */
506
+ export interface ApproximateDistinctAggregation {
507
+ field: FieldNameV1;
508
+ name?: AggregationMetricName;
509
+ }
510
+ /**
511
+ * Computes an approximate number of distinct values for the provided field.
512
+ *
513
+ * Log Safety: UNSAFE
514
+ */
515
+ export interface ApproximateDistinctAggregationV2 {
516
+ field: PropertyApiName;
517
+ name?: AggregationMetricName;
518
+ direction?: OrderByDirection;
519
+ }
520
+ /**
521
+ * Computes the approximate percentile value for the provided field. Requires Object Storage V2.
522
+ *
523
+ * Log Safety: UNSAFE
524
+ */
525
+ export interface ApproximatePercentileAggregationV2 {
526
+ field: PropertyApiName;
527
+ name?: AggregationMetricName;
528
+ approximatePercentile: number;
529
+ direction?: OrderByDirection;
530
+ }
531
+ /**
532
+ * Log Safety: UNSAFE
533
+ */
534
+ export interface Arg {
535
+ name: string;
536
+ value: string;
537
+ }
538
+ /**
539
+ * The parameter expects an array of values and the size of the array must fall within the defined range.
540
+ *
541
+ * Log Safety: UNSAFE
542
+ */
543
+ export interface ArraySizeConstraint {
544
+ lt?: any;
545
+ lte?: any;
546
+ gt?: any;
547
+ gte?: any;
548
+ }
549
+ /**
550
+ * Log Safety: SAFE
551
+ */
552
+ export type ArtifactRepositoryRid = LooselyBrandedString<"ArtifactRepositoryRid">;
553
+ /**
554
+ * Log Safety: SAFE
555
+ */
556
+ export type AsyncActionOperation = undefined;
557
+ /**
558
+ * Log Safety: SAFE
559
+ */
560
+ export type AsyncActionStatus = "RUNNING_SUBMISSION_CHECKS" | "EXECUTING_WRITE_BACK_WEBHOOK" | "COMPUTING_ONTOLOGY_EDITS" | "COMPUTING_FUNCTION" | "WRITING_ONTOLOGY_EDITS" | "EXECUTING_SIDE_EFFECT_WEBHOOK" | "SENDING_NOTIFICATIONS";
561
+ /**
562
+ * Log Safety: SAFE
563
+ */
564
+ export interface AsyncApplyActionOperationResponseV2 {
565
+ }
566
+ /**
567
+ * Log Safety: SAFE
568
+ */
569
+ export type AsyncApplyActionOperationV2 = undefined;
570
+ /**
571
+ * Log Safety: UNSAFE
572
+ */
573
+ export interface AsyncApplyActionRequest {
574
+ parameters: Record<ParameterId, DataValue | undefined>;
575
+ }
576
+ /**
577
+ * Log Safety: UNSAFE
578
+ */
579
+ export interface AsyncApplyActionRequestV2 {
580
+ parameters: Record<ParameterId, DataValue | undefined>;
581
+ }
582
+ /**
583
+ * Log Safety: SAFE
584
+ */
585
+ export interface AsyncApplyActionResponse {
586
+ }
587
+ /**
588
+ * Log Safety: SAFE
589
+ */
590
+ export interface AsyncApplyActionResponseV2 {
591
+ operationId: string;
592
+ }
593
+ /**
594
+ * The representation of an attachment.
595
+ *
596
+ * Log Safety: UNSAFE
597
+ */
598
+ export interface Attachment {
599
+ rid: AttachmentRid;
600
+ filename: _Core.Filename;
601
+ sizeBytes: _Core.SizeBytes;
602
+ mediaType: _Core.MediaType;
603
+ }
604
+ /**
605
+ * The attachment metadata response
606
+ *
607
+ * Log Safety: UNSAFE
608
+ */
609
+ export type AttachmentMetadataResponse = ({
610
+ type: "single";
611
+ } & AttachmentV2) | ({
612
+ type: "multiple";
613
+ } & ListAttachmentsResponseV2);
614
+ /**
615
+ * The representation of an attachment as a data type.
616
+ *
617
+ * Log Safety: SAFE
618
+ */
619
+ export interface AttachmentProperty {
620
+ rid: AttachmentRid;
621
+ }
622
+ /**
623
+ * Log Safety: UNSAFE
624
+ */
625
+ export type AttachmentPropertyV2 = LooselyBrandedString<"AttachmentPropertyV2">;
626
+ /**
627
+ * The unique resource identifier of an attachment.
628
+ *
629
+ * Log Safety: SAFE
630
+ */
631
+ export type AttachmentRid = LooselyBrandedString<"AttachmentRid">;
632
+ /**
633
+ * The representation of an attachment.
634
+ *
635
+ * Log Safety: UNSAFE
636
+ */
637
+ export interface AttachmentV2 {
638
+ rid: AttachmentRid;
639
+ filename: _Core.Filename;
640
+ sizeBytes: _Core.SizeBytes;
641
+ mediaType: _Core.MediaType;
642
+ }
643
+ /**
644
+ * Computes the average value for the provided field.
645
+ *
646
+ * Log Safety: UNSAFE
647
+ */
648
+ export interface AvgAggregation {
649
+ field: FieldNameV1;
650
+ name?: AggregationMetricName;
651
+ }
652
+ /**
653
+ * Computes the average value for the provided field.
654
+ *
655
+ * Log Safety: UNSAFE
656
+ */
657
+ export interface AvgAggregationV2 {
658
+ field: PropertyApiName;
659
+ name?: AggregationMetricName;
660
+ direction?: OrderByDirection;
661
+ }
662
+ /**
663
+ * Log Safety: UNSAFE
664
+ */
665
+ export interface BatchApplyActionRequest {
666
+ requests: Array<ApplyActionRequest>;
667
+ }
668
+ /**
669
+ * Log Safety: UNSAFE
670
+ */
671
+ export interface BatchApplyActionRequestItem {
672
+ parameters: Record<ParameterId, DataValue | undefined>;
673
+ }
674
+ /**
675
+ * Log Safety: SAFE
676
+ */
677
+ export interface BatchApplyActionRequestOptions {
678
+ returnEdits?: ReturnEditsMode;
679
+ }
680
+ /**
681
+ * Log Safety: UNSAFE
682
+ */
683
+ export interface BatchApplyActionRequestV2 {
684
+ options?: BatchApplyActionRequestOptions;
685
+ requests: Array<BatchApplyActionRequestItem>;
686
+ }
687
+ /**
688
+ * Log Safety: SAFE
689
+ */
690
+ export interface BatchApplyActionResponse {
691
+ }
692
+ /**
693
+ * Log Safety: UNSAFE
694
+ */
695
+ export interface BatchApplyActionResponseV2 {
696
+ edits?: ActionResults;
697
+ }
698
+ /**
699
+ * Log Safety: UNSAFE
700
+ */
701
+ export interface BlueprintIcon {
702
+ color: string;
703
+ name: string;
704
+ }
705
+ /**
706
+ * The top left and bottom right coordinate points that make up the bounding box.
707
+ *
708
+ * Log Safety: UNSAFE
709
+ */
710
+ export interface BoundingBoxValue {
711
+ topLeft: WithinBoundingBoxPoint;
712
+ bottomRight: WithinBoundingBoxPoint;
713
+ }
714
+ /**
715
+ * The coordinate point to use as the center of the distance query.
716
+ *
717
+ * Log Safety: UNSAFE
718
+ */
719
+ export interface CenterPoint {
720
+ center: CenterPointTypes;
721
+ distance: _Core.Distance;
722
+ }
723
+ /**
724
+ * Log Safety: UNSAFE
725
+ */
726
+ export type CenterPointTypes = {
727
+ type: "Point";
728
+ } & _Geo.GeoPoint;
729
+ /**
730
+ * Returns objects where the specified field contains all of the terms in the order provided,
731
+ but they do have to be adjacent to each other.
732
+ The last term can be a partial prefix match. Allows you to specify a property to query on
733
+ by a variety of means. Either field or propertyIdentifier can be supplied, but not both.
734
+ *
735
+ * Log Safety: UNSAFE
736
+ */
737
+ export interface ContainsAllTermsInOrderPrefixLastTerm {
738
+ field?: PropertyApiName;
739
+ propertyIdentifier?: PropertyIdentifier;
740
+ value: string;
741
+ }
742
+ /**
743
+ * Returns objects where the specified field contains all of the terms in the order provided,
744
+ but they do have to be adjacent to each other. Allows you to specify a property to query on
745
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
746
+ *
747
+ * Log Safety: UNSAFE
748
+ */
749
+ export interface ContainsAllTermsInOrderQuery {
750
+ field?: PropertyApiName;
751
+ propertyIdentifier?: PropertyIdentifier;
752
+ value: string;
753
+ }
754
+ /**
755
+ * Returns objects where the specified field contains all of the whitespace separated words in any
756
+ order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on
757
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
758
+ *
759
+ * Log Safety: UNSAFE
760
+ */
761
+ export interface ContainsAllTermsQuery {
762
+ field?: PropertyApiName;
763
+ propertyIdentifier?: PropertyIdentifier;
764
+ value: string;
765
+ fuzzy?: FuzzyV2;
766
+ }
767
+ /**
768
+ * Returns objects where the specified field contains any of the whitespace separated words in any
769
+ order in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on
770
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
771
+ *
772
+ * Log Safety: UNSAFE
773
+ */
774
+ export interface ContainsAnyTermQuery {
775
+ field?: PropertyApiName;
776
+ propertyIdentifier?: PropertyIdentifier;
777
+ value: string;
778
+ fuzzy?: FuzzyV2;
779
+ }
780
+ /**
781
+ * Returns objects where the specified array contains a value.
782
+ *
783
+ * Log Safety: UNSAFE
784
+ */
785
+ export interface ContainsQuery {
786
+ field: FieldNameV1;
787
+ value: PropertyValue;
788
+ }
789
+ /**
790
+ * Returns objects where the specified array contains a value. Allows you to specify a property to query on by a
791
+ variety of means. Either field or propertyIdentifier must be supplied, but not both.
792
+ *
793
+ * Log Safety: UNSAFE
794
+ */
795
+ export interface ContainsQueryV2 {
796
+ field?: PropertyApiName;
797
+ propertyIdentifier?: PropertyIdentifier;
798
+ value: PropertyValue;
799
+ }
800
+ /**
801
+ * Computes the total count of objects.
802
+ *
803
+ * Log Safety: UNSAFE
804
+ */
805
+ export interface CountAggregation {
806
+ name?: AggregationMetricName;
807
+ }
808
+ /**
809
+ * Computes the total count of objects.
810
+ *
811
+ * Log Safety: UNSAFE
812
+ */
813
+ export interface CountAggregationV2 {
814
+ name?: AggregationMetricName;
815
+ direction?: OrderByDirection;
816
+ }
817
+ /**
818
+ * Log Safety: UNSAFE
819
+ */
820
+ export interface CountObjectsResponseV2 {
821
+ count?: number;
822
+ }
823
+ /**
824
+ * Log Safety: UNSAFE
825
+ */
826
+ export interface CreateInterfaceObjectRule {
827
+ interfaceTypeApiName: InterfaceTypeApiName;
828
+ }
829
+ /**
830
+ * Log Safety: UNSAFE
831
+ */
832
+ export interface CreateLinkRule {
833
+ linkTypeApiNameAtoB: LinkTypeApiName;
834
+ linkTypeApiNameBtoA: LinkTypeApiName;
835
+ aSideObjectTypeApiName: ObjectTypeApiName;
836
+ bSideObjectTypeApiName: ObjectTypeApiName;
837
+ }
838
+ /**
839
+ * Log Safety: UNSAFE
840
+ */
841
+ export interface CreateObjectRule {
842
+ objectTypeApiName: ObjectTypeApiName;
843
+ }
844
+ /**
845
+ * Log Safety: UNSAFE
846
+ */
847
+ export interface CreateTemporaryObjectSetRequestV2 {
848
+ objectSet: ObjectSet;
849
+ }
850
+ /**
851
+ * Log Safety: SAFE
852
+ */
853
+ export interface CreateTemporaryObjectSetResponseV2 {
854
+ objectSetRid: ObjectSetRid;
855
+ }
856
+ /**
857
+ * A UUID representing a custom type in a given Function.
858
+ *
859
+ * Log Safety: SAFE
860
+ */
861
+ export type CustomTypeId = LooselyBrandedString<"CustomTypeId">;
862
+ /**
863
+ * Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.
864
+ | Type | JSON encoding | Example |
865
+ |-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
866
+ | Array | array | ["alpha", "bravo", "charlie"] |
867
+ | Attachment | string | "ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e" |
868
+ | Boolean | boolean | true |
869
+ | Byte | number | 31 |
870
+ | CipherText | string | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER" |
871
+ | Date | ISO 8601 extended local date string | "2021-05-01" |
872
+ | Decimal | string | "2.718281828" |
873
+ | Float | number | 3.14159265 |
874
+ | Double | number | 3.14159265 |
875
+ | Integer | number | 238940 |
876
+ | Long | string | "58319870951433" |
877
+ | Marking | string | "MU" |
878
+ | Null | null | null |
879
+ | Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z |
880
+ | Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or "EMP1234" |
881
+ | Ontology Interface Object Reference | JSON encoding of the object's api name and primary key| {"objectTypeApiName":"Employee", "primaryKeyValue":"EMP1234"} |
882
+ | Ontology Object Type Reference | string of the object type's api name | "Employee" |
883
+ | Set | array | ["alpha", "bravo", "charlie"] |
884
+ | Short | number | 8739 |
885
+ | String | string | "Call me Ishmael" |
886
+ | Struct | JSON object | {"name": "John Doe", "age": 42} |
887
+ | TwoDimensionalAggregation | JSON object | {"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]} |
888
+ | ThreeDimensionalAggregation | JSON object | {"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]} |
889
+ | Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
890
+ *
891
+ * Log Safety: UNSAFE
892
+ */
893
+ export type DataValue = any;
894
+ /**
895
+ * Log Safety: UNSAFE
896
+ */
897
+ export interface DeleteInterfaceObjectRule {
898
+ interfaceTypeApiName: InterfaceTypeApiName;
899
+ }
900
+ /**
901
+ * Log Safety: UNSAFE
902
+ */
903
+ export interface DeleteLinkRule {
904
+ linkTypeApiNameAtoB: LinkTypeApiName;
905
+ linkTypeApiNameBtoA: LinkTypeApiName;
906
+ aSideObjectTypeApiName: ObjectTypeApiName;
907
+ bSideObjectTypeApiName: ObjectTypeApiName;
908
+ }
909
+ /**
910
+ * Log Safety: UNSAFE
911
+ */
912
+ export interface DeleteObjectRule {
913
+ objectTypeApiName: ObjectTypeApiName;
914
+ }
915
+ /**
916
+ * This status indicates that the PropertyType is reaching the end of its life and will be removed as per the
917
+ deadline specified.
918
+ *
919
+ * Log Safety: UNSAFE
920
+ */
921
+ export interface DeprecatedPropertyTypeStatus {
922
+ message: string;
923
+ deadline: string;
924
+ replacedBy?: PropertyTypeRid;
925
+ }
926
+ /**
927
+ * The name of the derived property that will be returned.
928
+ *
929
+ * Log Safety: UNSAFE
930
+ */
931
+ export type DerivedPropertyApiName = LooselyBrandedString<"DerivedPropertyApiName">;
932
+ /**
933
+ * Definition of a derived property.
934
+ *
935
+ * Log Safety: UNSAFE
936
+ */
937
+ export type DerivedPropertyDefinition = {
938
+ type: "selection";
939
+ } & SelectedPropertyDefinition;
940
+ /**
941
+ * The representation of a time series property backed by a derived time series calculated with a formula.
942
+ *
943
+ * Log Safety: UNSAFE
944
+ */
945
+ export interface DerivedTimeSeriesProperty {
946
+ templateRid: TimeseriesTemplateRid;
947
+ templateVersion?: TimeseriesTemplateVersion;
948
+ }
949
+ /**
950
+ * Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a
951
+ property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not
952
+ both.
953
+ *
954
+ * Log Safety: UNSAFE
955
+ */
956
+ export interface DoesNotIntersectBoundingBoxQuery {
957
+ field?: PropertyApiName;
958
+ propertyIdentifier?: PropertyIdentifier;
959
+ value: BoundingBoxValue;
960
+ }
961
+ /**
962
+ * Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a
963
+ property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not
964
+ both.
965
+ *
966
+ * Log Safety: UNSAFE
967
+ */
968
+ export interface DoesNotIntersectPolygonQuery {
969
+ field?: PropertyApiName;
970
+ propertyIdentifier?: PropertyIdentifier;
971
+ value: PolygonValue;
972
+ }
973
+ /**
974
+ * The vector to search with. The vector must be of the same dimension as the vectors stored in the provided
975
+ propertyIdentifier.
976
+ *
977
+ * Log Safety: UNSAFE
978
+ */
979
+ export interface DoubleVector {
980
+ value: Array<number>;
981
+ }
982
+ /**
983
+ * An ISO 8601 formatted duration.
984
+ *
985
+ * Log Safety: UNSAFE
986
+ */
987
+ export type Duration = LooselyBrandedString<"Duration">;
988
+ /**
989
+ * Returns objects where the specified field is equal to a value.
990
+ *
991
+ * Log Safety: UNSAFE
992
+ */
993
+ export interface EqualsQuery {
994
+ field: FieldNameV1;
995
+ value: PropertyValue;
996
+ }
997
+ /**
998
+ * Returns objects where the specified field is equal to a value. Allows you to specify a property to query on
999
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1000
+ *
1001
+ * Log Safety: UNSAFE
1002
+ */
1003
+ export interface EqualsQueryV2 {
1004
+ field?: PropertyApiName;
1005
+ propertyIdentifier?: PropertyIdentifier;
1006
+ value: PropertyValue;
1007
+ }
1008
+ /**
1009
+ * Log Safety: UNSAFE
1010
+ */
1011
+ export interface Error {
1012
+ error: ErrorName;
1013
+ args: Array<Arg>;
1014
+ }
1015
+ /**
1016
+ * Log Safety: SAFE
1017
+ */
1018
+ export type ErrorName = LooselyBrandedString<"ErrorName">;
1019
+ /**
1020
+ * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.
1021
+ *
1022
+ * Log Safety: UNSAFE
1023
+ */
1024
+ export interface ExactDistinctAggregationV2 {
1025
+ field: PropertyApiName;
1026
+ name?: AggregationMetricName;
1027
+ direction?: OrderByDirection;
1028
+ }
1029
+ /**
1030
+ * This status indicates that the PropertyType is an example. It is backed by notional data that should not be
1031
+ used for actual workflows, but can be used to test those workflows.
1032
+ *
1033
+ * Log Safety: SAFE
1034
+ */
1035
+ export interface ExamplePropertyTypeStatus {
1036
+ }
1037
+ /**
1038
+ * Log Safety: UNSAFE
1039
+ */
1040
+ export interface ExecuteQueryRequest {
1041
+ parameters: Record<ParameterId, DataValue | undefined>;
1042
+ }
1043
+ /**
1044
+ * Log Safety: UNSAFE
1045
+ */
1046
+ export interface ExecuteQueryResponse {
1047
+ value: DataValue;
1048
+ }
1049
+ /**
1050
+ * This status indicates that the PropertyType is in development.
1051
+ *
1052
+ * Log Safety: SAFE
1053
+ */
1054
+ export interface ExperimentalPropertyTypeStatus {
1055
+ }
1056
+ /**
1057
+ * A reference to an Ontology object property with the form properties.{propertyApiName}.
1058
+ *
1059
+ * Log Safety: UNSAFE
1060
+ */
1061
+ export type FieldNameV1 = LooselyBrandedString<"FieldNameV1">;
1062
+ /**
1063
+ * Represents the value of a property filter. For instance, false is the FilterValue in
1064
+ properties.{propertyApiName}.isNull=false.
1065
+ *
1066
+ * Log Safety: UNSAFE
1067
+ */
1068
+ export type FilterValue = LooselyBrandedString<"FilterValue">;
1069
+ /**
1070
+ * The unique resource identifier of a Function, useful for interacting with other Foundry APIs.
1071
+ *
1072
+ * Log Safety: SAFE
1073
+ */
1074
+ export type FunctionRid = LooselyBrandedString<"FunctionRid">;
1075
+ /**
1076
+ * The version of the given Function, written <major>.<minor>.<patch>-<tag>, where -<tag> is optional.
1077
+ Examples: 1.2.3, 1.2.3-rc1.
1078
+ *
1079
+ * Log Safety: UNSAFE
1080
+ */
1081
+ export type FunctionVersion = LooselyBrandedString<"FunctionVersion">;
1082
+ /**
1083
+ * Setting fuzzy to true allows approximate matching in search queries that support it.
1084
+ *
1085
+ * Log Safety: SAFE
1086
+ */
1087
+ export type Fuzzy = boolean;
1088
+ /**
1089
+ * Setting fuzzy to true allows approximate matching in search queries that support it.
1090
+ *
1091
+ * Log Safety: SAFE
1092
+ */
1093
+ export type FuzzyV2 = boolean;
1094
+ /**
1095
+ * The unique id of a geotime series (track) associated with a GTSR.
1096
+ *
1097
+ * Log Safety: UNSAFE
1098
+ */
1099
+ export type GeotimeSeriesId = LooselyBrandedString<"GeotimeSeriesId">;
1100
+ /**
1101
+ * The unique resource identifier of a geotime integration.
1102
+ *
1103
+ * Log Safety: SAFE
1104
+ */
1105
+ export type GeotimeSeriesIntegrationRid = LooselyBrandedString<"GeotimeSeriesIntegrationRid">;
1106
+ /**
1107
+ * The representation of a geotime series integration as a data type.
1108
+ *
1109
+ * Log Safety: UNSAFE
1110
+ */
1111
+ export interface GeotimeSeriesProperty {
1112
+ geotimeSeriesId: GeotimeSeriesId;
1113
+ geotimeSeriesIntegrationRid: GeotimeSeriesIntegrationRid;
1114
+ }
1115
+ /**
1116
+ * The underlying data values pointed to by a GeotimeSeriesReference.
1117
+ *
1118
+ * Log Safety: UNSAFE
1119
+ */
1120
+ export interface GeotimeSeriesValue {
1121
+ position: _Geo.Position;
1122
+ timestamp: string;
1123
+ }
1124
+ /**
1125
+ * Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could
1126
+ explode the cardinality.
1127
+ Use collectList or collectSet which will return a list of values in that case.
1128
+ *
1129
+ * Log Safety: UNSAFE
1130
+ */
1131
+ export interface GetSelectedPropertyOperation {
1132
+ selectedPropertyApiName: PropertyApiName;
1133
+ }
1134
+ /**
1135
+ * The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.
1136
+ *
1137
+ * Log Safety: SAFE
1138
+ */
1139
+ export interface GroupMemberConstraint {
1140
+ }
1141
+ /**
1142
+ * Returns objects where the specified field is greater than or equal to a value.
1143
+ *
1144
+ * Log Safety: UNSAFE
1145
+ */
1146
+ export interface GteQuery {
1147
+ field: FieldNameV1;
1148
+ value: PropertyValue;
1149
+ }
1150
+ /**
1151
+ * Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property
1152
+ to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1153
+ *
1154
+ * Log Safety: UNSAFE
1155
+ */
1156
+ export interface GteQueryV2 {
1157
+ field?: PropertyApiName;
1158
+ propertyIdentifier?: PropertyIdentifier;
1159
+ value: PropertyValue;
1160
+ }
1161
+ /**
1162
+ * Returns objects where the specified field is greater than a value.
1163
+ *
1164
+ * Log Safety: UNSAFE
1165
+ */
1166
+ export interface GtQuery {
1167
+ field: FieldNameV1;
1168
+ value: PropertyValue;
1169
+ }
1170
+ /**
1171
+ * Returns objects where the specified field is greater than a value. Allows you to specify a property to query on
1172
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1173
+ *
1174
+ * Log Safety: UNSAFE
1175
+ */
1176
+ export interface GtQueryV2 {
1177
+ field?: PropertyApiName;
1178
+ propertyIdentifier?: PropertyIdentifier;
1179
+ value: PropertyValue;
1180
+ }
1181
+ /**
1182
+ * A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).
1183
+ *
1184
+ * Log Safety: UNSAFE
1185
+ */
1186
+ export type Icon = {
1187
+ type: "blueprint";
1188
+ } & BlueprintIcon;
1189
+ /**
1190
+ * Returns objects where the specified field equals any of the provided values. Allows you to
1191
+ specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,
1192
+ but not both.
1193
+ *
1194
+ * Log Safety: UNSAFE
1195
+ */
1196
+ export interface InQuery {
1197
+ field?: PropertyApiName;
1198
+ propertyIdentifier?: PropertyIdentifier;
1199
+ value: Array<PropertyValue>;
1200
+ }
1201
+ /**
1202
+ * A link type constraint defined at the interface level where the implementation of the links is provided
1203
+ by the implementing object types.
1204
+ *
1205
+ * Log Safety: UNSAFE
1206
+ */
1207
+ export interface InterfaceLinkType {
1208
+ rid: InterfaceLinkTypeRid;
1209
+ apiName: InterfaceLinkTypeApiName;
1210
+ displayName: _Core.DisplayName;
1211
+ description?: string;
1212
+ linkedEntityApiName: InterfaceLinkTypeLinkedEntityApiName;
1213
+ cardinality: InterfaceLinkTypeCardinality;
1214
+ required: boolean;
1215
+ }
1216
+ /**
1217
+ * A string indicating the API name to use for the interface link.
1218
+ *
1219
+ * Log Safety: UNSAFE
1220
+ */
1221
+ export type InterfaceLinkTypeApiName = LooselyBrandedString<"InterfaceLinkTypeApiName">;
1222
+ /**
1223
+ * The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can
1224
+ link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects.
1225
+ *
1226
+ * Log Safety: SAFE
1227
+ */
1228
+ export type InterfaceLinkTypeCardinality = "ONE" | "MANY";
1229
+ /**
1230
+ * A reference to the linked entity. This can either be an object or an interface type.
1231
+ *
1232
+ * Log Safety: UNSAFE
1233
+ */
1234
+ export type InterfaceLinkTypeLinkedEntityApiName = ({
1235
+ type: "objectTypeApiName";
1236
+ } & LinkedObjectTypeApiName) | ({
1237
+ type: "interfaceTypeApiName";
1238
+ } & LinkedInterfaceTypeApiName);
1239
+ /**
1240
+ * The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.
1241
+ *
1242
+ * Log Safety: SAFE
1243
+ */
1244
+ export type InterfaceLinkTypeRid = LooselyBrandedString<"InterfaceLinkTypeRid">;
1245
+ /**
1246
+ * Represents an implementation of an interface (the mapping of interface property to local property).
1247
+ *
1248
+ * Log Safety: UNSAFE
1249
+ */
1250
+ export type InterfaceToObjectTypeMapping = Record<SharedPropertyTypeApiName, PropertyApiName>;
1251
+ /**
1252
+ * Map from object type to the interface-to-object-type mapping for that object type.
1253
+ *
1254
+ * Log Safety: UNSAFE
1255
+ */
1256
+ export type InterfaceToObjectTypeMappings = Record<ObjectTypeApiName, InterfaceToObjectTypeMapping>;
1257
+ /**
1258
+ * Represents an interface type in the Ontology.
1259
+ *
1260
+ * Log Safety: UNSAFE
1261
+ */
1262
+ export interface InterfaceType {
1263
+ rid: InterfaceTypeRid;
1264
+ apiName: InterfaceTypeApiName;
1265
+ displayName: _Core.DisplayName;
1266
+ description?: string;
1267
+ properties: Record<SharedPropertyTypeApiName, SharedPropertyType>;
1268
+ allProperties: Record<SharedPropertyTypeApiName, SharedPropertyType>;
1269
+ extendsInterfaces: Array<InterfaceTypeApiName>;
1270
+ allExtendsInterfaces: Array<InterfaceTypeApiName>;
1271
+ implementedByObjectTypes: Array<ObjectTypeApiName>;
1272
+ links: Record<InterfaceLinkTypeApiName, InterfaceLinkType>;
1273
+ allLinks: Record<InterfaceLinkTypeApiName, InterfaceLinkType>;
1274
+ }
1275
+ /**
1276
+ * The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface
1277
+ type, use the List interface types endpoint or check the Ontology Manager.
1278
+ *
1279
+ * Log Safety: UNSAFE
1280
+ */
1281
+ export type InterfaceTypeApiName = LooselyBrandedString<"InterfaceTypeApiName">;
1282
+ /**
1283
+ * The unique resource identifier of an interface, useful for interacting with other Foundry APIs.
1284
+ *
1285
+ * Log Safety: SAFE
1286
+ */
1287
+ export type InterfaceTypeRid = LooselyBrandedString<"InterfaceTypeRid">;
1288
+ /**
1289
+ * Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property
1290
+ to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1291
+ *
1292
+ * Log Safety: UNSAFE
1293
+ */
1294
+ export interface IntersectsBoundingBoxQuery {
1295
+ field?: PropertyApiName;
1296
+ propertyIdentifier?: PropertyIdentifier;
1297
+ value: BoundingBoxValue;
1298
+ }
1299
+ /**
1300
+ * Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to
1301
+ query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1302
+ *
1303
+ * Log Safety: UNSAFE
1304
+ */
1305
+ export interface IntersectsPolygonQuery {
1306
+ field?: PropertyApiName;
1307
+ propertyIdentifier?: PropertyIdentifier;
1308
+ value: PolygonValue;
1309
+ }
1310
+ /**
1311
+ * Returns objects based on the existence of the specified field.
1312
+ *
1313
+ * Log Safety: UNSAFE
1314
+ */
1315
+ export interface IsNullQuery {
1316
+ field: FieldNameV1;
1317
+ value: boolean;
1318
+ }
1319
+ /**
1320
+ * Returns objects based on the existence of the specified field. Allows you to specify a property to query on
1321
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1322
+ *
1323
+ * Log Safety: UNSAFE
1324
+ */
1325
+ export interface IsNullQueryV2 {
1326
+ field?: PropertyApiName;
1327
+ propertyIdentifier?: PropertyIdentifier;
1328
+ value: boolean;
1329
+ }
1330
+ /**
1331
+ * A reference to the linked interface type.
1332
+ *
1333
+ * Log Safety: UNSAFE
1334
+ */
1335
+ export interface LinkedInterfaceTypeApiName {
1336
+ apiName: InterfaceTypeApiName;
1337
+ }
1338
+ /**
1339
+ * A reference to the linked object type.
1340
+ *
1341
+ * Log Safety: UNSAFE
1342
+ */
1343
+ export interface LinkedObjectTypeApiName {
1344
+ apiName: ObjectTypeApiName;
1345
+ }
1346
+ /**
1347
+ * Log Safety: UNSAFE
1348
+ */
1349
+ export type LinkedObjectV2 = LooselyBrandedString<"LinkedObjectV2">;
1350
+ /**
1351
+ * Log Safety: UNSAFE
1352
+ */
1353
+ export interface LinkSideObject {
1354
+ primaryKey: PropertyValue;
1355
+ objectType: ObjectTypeApiName;
1356
+ }
1357
+ /**
1358
+ * The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager
1359
+ application.
1360
+ *
1361
+ * Log Safety: UNSAFE
1362
+ */
1363
+ export type LinkTypeApiName = LooselyBrandedString<"LinkTypeApiName">;
1364
+ /**
1365
+ * Log Safety: SAFE
1366
+ */
1367
+ export type LinkTypeRid = LooselyBrandedString<"LinkTypeRid">;
1368
+ /**
1369
+ * Log Safety: UNSAFE
1370
+ */
1371
+ export interface LinkTypeSide {
1372
+ apiName: LinkTypeApiName;
1373
+ displayName: _Core.DisplayName;
1374
+ status: _Core.ReleaseStatus;
1375
+ objectTypeApiName: ObjectTypeApiName;
1376
+ cardinality: LinkTypeSideCardinality;
1377
+ foreignKeyPropertyApiName?: PropertyApiName;
1378
+ }
1379
+ /**
1380
+ * Log Safety: SAFE
1381
+ */
1382
+ export type LinkTypeSideCardinality = "ONE" | "MANY";
1383
+ /**
1384
+ * Log Safety: UNSAFE
1385
+ */
1386
+ export interface LinkTypeSideV2 {
1387
+ apiName: LinkTypeApiName;
1388
+ displayName: _Core.DisplayName;
1389
+ status: _Core.ReleaseStatus;
1390
+ objectTypeApiName: ObjectTypeApiName;
1391
+ cardinality: LinkTypeSideCardinality;
1392
+ foreignKeyPropertyApiName?: PropertyApiName;
1393
+ linkTypeRid: LinkTypeRid;
1394
+ }
1395
+ /**
1396
+ * Log Safety: UNSAFE
1397
+ */
1398
+ export interface ListActionTypesResponse {
1399
+ nextPageToken?: _Core.PageToken;
1400
+ data: Array<ActionType>;
1401
+ }
1402
+ /**
1403
+ * Log Safety: UNSAFE
1404
+ */
1405
+ export interface ListActionTypesResponseV2 {
1406
+ nextPageToken?: _Core.PageToken;
1407
+ data: Array<ActionTypeV2>;
1408
+ }
1409
+ /**
1410
+ * Log Safety: UNSAFE
1411
+ */
1412
+ export interface ListAttachmentsResponseV2 {
1413
+ data: Array<AttachmentV2>;
1414
+ nextPageToken?: _Core.PageToken;
1415
+ }
1416
+ /**
1417
+ * Log Safety: UNSAFE
1418
+ */
1419
+ export interface ListInterfaceTypesResponse {
1420
+ nextPageToken?: _Core.PageToken;
1421
+ data: Array<InterfaceType>;
1422
+ }
1423
+ /**
1424
+ * Log Safety: UNSAFE
1425
+ */
1426
+ export interface ListLinkedObjectsResponse {
1427
+ nextPageToken?: _Core.PageToken;
1428
+ data: Array<OntologyObject>;
1429
+ }
1430
+ /**
1431
+ * Log Safety: UNSAFE
1432
+ */
1433
+ export interface ListLinkedObjectsResponseV2 {
1434
+ data: Array<OntologyObjectV2>;
1435
+ nextPageToken?: _Core.PageToken;
1436
+ }
1437
+ /**
1438
+ * Log Safety: UNSAFE
1439
+ */
1440
+ export interface ListObjectsResponse {
1441
+ nextPageToken?: _Core.PageToken;
1442
+ data: Array<OntologyObject>;
1443
+ totalCount: _Core.TotalCount;
1444
+ }
1445
+ /**
1446
+ * Log Safety: UNSAFE
1447
+ */
1448
+ export interface ListObjectsResponseV2 {
1449
+ nextPageToken?: _Core.PageToken;
1450
+ data: Array<OntologyObjectV2>;
1451
+ totalCount: _Core.TotalCount;
1452
+ }
1453
+ /**
1454
+ * Log Safety: UNSAFE
1455
+ */
1456
+ export interface ListObjectTypesResponse {
1457
+ nextPageToken?: _Core.PageToken;
1458
+ data: Array<ObjectType>;
1459
+ }
1460
+ /**
1461
+ * Log Safety: UNSAFE
1462
+ */
1463
+ export interface ListObjectTypesV2Response {
1464
+ nextPageToken?: _Core.PageToken;
1465
+ data: Array<ObjectTypeV2>;
1466
+ }
1467
+ /**
1468
+ * Log Safety: UNSAFE
1469
+ */
1470
+ export interface ListOntologiesResponse {
1471
+ data: Array<Ontology>;
1472
+ }
1473
+ /**
1474
+ * Log Safety: UNSAFE
1475
+ */
1476
+ export interface ListOntologiesV2Response {
1477
+ data: Array<OntologyV2>;
1478
+ }
1479
+ /**
1480
+ * Log Safety: UNSAFE
1481
+ */
1482
+ export interface ListOutgoingLinkTypesResponse {
1483
+ nextPageToken?: _Core.PageToken;
1484
+ data: Array<LinkTypeSide>;
1485
+ }
1486
+ /**
1487
+ * Log Safety: UNSAFE
1488
+ */
1489
+ export interface ListOutgoingLinkTypesResponseV2 {
1490
+ nextPageToken?: _Core.PageToken;
1491
+ data: Array<LinkTypeSideV2>;
1492
+ }
1493
+ /**
1494
+ * Log Safety: UNSAFE
1495
+ */
1496
+ export interface ListQueryTypesResponse {
1497
+ nextPageToken?: _Core.PageToken;
1498
+ data: Array<QueryType>;
1499
+ }
1500
+ /**
1501
+ * Log Safety: UNSAFE
1502
+ */
1503
+ export interface ListQueryTypesResponseV2 {
1504
+ nextPageToken?: _Core.PageToken;
1505
+ data: Array<QueryTypeV2>;
1506
+ }
1507
+ /**
1508
+ * Represents the API POST body when loading an ObjectSet.
1509
+ *
1510
+ * Log Safety: UNSAFE
1511
+ */
1512
+ export interface LoadObjectSetRequestV2 {
1513
+ objectSet: ObjectSet;
1514
+ orderBy?: SearchOrderByV2;
1515
+ select: Array<SelectedPropertyApiName>;
1516
+ pageToken?: _Core.PageToken;
1517
+ pageSize?: _Core.PageSize;
1518
+ excludeRid?: boolean;
1519
+ }
1520
+ /**
1521
+ * Represents the API response when loading an ObjectSet.
1522
+ *
1523
+ * Log Safety: UNSAFE
1524
+ */
1525
+ export interface LoadObjectSetResponseV2 {
1526
+ data: Array<OntologyObjectV2>;
1527
+ nextPageToken?: _Core.PageToken;
1528
+ totalCount: _Core.TotalCount;
1529
+ }
1530
+ /**
1531
+ * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.
1532
+ *
1533
+ * Log Safety: UNSAFE
1534
+ */
1535
+ export interface LoadObjectSetV2MultipleObjectTypesRequest {
1536
+ objectSet: ObjectSet;
1537
+ orderBy?: SearchOrderByV2;
1538
+ select: Array<SelectedPropertyApiName>;
1539
+ pageToken?: _Core.PageToken;
1540
+ pageSize?: _Core.PageSize;
1541
+ excludeRid?: boolean;
1542
+ }
1543
+ /**
1544
+ * Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is
1545
+ optionally returned if the type scope of the returned object set includes any interfaces. The "type scope"
1546
+ of an object set refers to whether objects contain all their properties (object-type type scope) or just the
1547
+ properties that implement interface properties (interface type scope). There can be multiple type scopes in a
1548
+ single object set- some objects may have all their properties and some may only have interface properties.
1549
+ The interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to
1550
+ PropertyApiName for properties on the object(s).
1551
+ *
1552
+ * Log Safety: UNSAFE
1553
+ */
1554
+ export interface LoadObjectSetV2MultipleObjectTypesResponse {
1555
+ data: Array<OntologyObjectV2>;
1556
+ nextPageToken?: _Core.PageToken;
1557
+ totalCount: _Core.TotalCount;
1558
+ interfaceToObjectTypeMappings: Record<InterfaceTypeApiName, InterfaceToObjectTypeMappings>;
1559
+ }
1560
+ /**
1561
+ * Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.
1562
+ *
1563
+ * Log Safety: UNSAFE
1564
+ */
1565
+ export interface LoadObjectSetV2ObjectsOrInterfacesRequest {
1566
+ objectSet: ObjectSet;
1567
+ orderBy?: SearchOrderByV2;
1568
+ select: Array<SelectedPropertyApiName>;
1569
+ pageToken?: _Core.PageToken;
1570
+ pageSize?: _Core.PageSize;
1571
+ excludeRid?: boolean;
1572
+ }
1573
+ /**
1574
+ * Represents the API response when loading an ObjectSet. Objects in the returned set can either have properties
1575
+ defined by an interface that the objects belong to or properties defined by the object type of the object.
1576
+ *
1577
+ * Log Safety: UNSAFE
1578
+ */
1579
+ export interface LoadObjectSetV2ObjectsOrInterfacesResponse {
1580
+ data: Array<OntologyObjectV2>;
1581
+ nextPageToken?: _Core.PageToken;
1582
+ totalCount: _Core.TotalCount;
1583
+ }
1584
+ /**
1585
+ * Log Safety: UNSAFE
1586
+ */
1587
+ export type LogicRule = ({
1588
+ type: "deleteInterfaceObject";
1589
+ } & DeleteInterfaceObjectRule) | ({
1590
+ type: "modifyInterfaceObject";
1591
+ } & ModifyInterfaceObjectRule) | ({
1592
+ type: "modifyObject";
1593
+ } & ModifyObjectRule) | ({
1594
+ type: "deleteObject";
1595
+ } & DeleteObjectRule) | ({
1596
+ type: "createInterfaceObject";
1597
+ } & CreateInterfaceObjectRule) | ({
1598
+ type: "deleteLink";
1599
+ } & DeleteLinkRule) | ({
1600
+ type: "createObject";
1601
+ } & CreateObjectRule) | ({
1602
+ type: "createLink";
1603
+ } & CreateLinkRule);
1604
+ /**
1605
+ * Returns objects where the specified field is less than or equal to a value.
1606
+ *
1607
+ * Log Safety: UNSAFE
1608
+ */
1609
+ export interface LteQuery {
1610
+ field: FieldNameV1;
1611
+ value: PropertyValue;
1612
+ }
1613
+ /**
1614
+ * Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to
1615
+ query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1616
+ *
1617
+ * Log Safety: UNSAFE
1618
+ */
1619
+ export interface LteQueryV2 {
1620
+ field?: PropertyApiName;
1621
+ propertyIdentifier?: PropertyIdentifier;
1622
+ value: PropertyValue;
1623
+ }
1624
+ /**
1625
+ * Returns objects where the specified field is less than a value.
1626
+ *
1627
+ * Log Safety: UNSAFE
1628
+ */
1629
+ export interface LtQuery {
1630
+ field: FieldNameV1;
1631
+ value: PropertyValue;
1632
+ }
1633
+ /**
1634
+ * Returns objects where the specified field is less than a value. Allows you to specify a property to query on
1635
+ by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
1636
+ *
1637
+ * Log Safety: UNSAFE
1638
+ */
1639
+ export interface LtQueryV2 {
1640
+ field?: PropertyApiName;
1641
+ propertyIdentifier?: PropertyIdentifier;
1642
+ value: PropertyValue;
1643
+ }
1644
+ /**
1645
+ * Computes the maximum value for the provided field.
1646
+ *
1647
+ * Log Safety: UNSAFE
1648
+ */
1649
+ export interface MaxAggregation {
1650
+ field: FieldNameV1;
1651
+ name?: AggregationMetricName;
1652
+ }
1653
+ /**
1654
+ * Computes the maximum value for the provided field.
1655
+ *
1656
+ * Log Safety: UNSAFE
1657
+ */
1658
+ export interface MaxAggregationV2 {
1659
+ field: PropertyApiName;
1660
+ name?: AggregationMetricName;
1661
+ direction?: OrderByDirection;
1662
+ }
1663
+ /**
1664
+ * Log Safety: UNSAFE
1665
+ */
1666
+ export interface MediaMetadata {
1667
+ path?: _Core.MediaItemPath;
1668
+ sizeBytes: _Core.SizeBytes;
1669
+ mediaType: _Core.MediaType;
1670
+ }
1671
+ /**
1672
+ * Log Safety: UNSAFE
1673
+ */
1674
+ export type MediaReferenceProperty = LooselyBrandedString<"MediaReferenceProperty">;
1675
+ /**
1676
+ * Log Safety: UNSAFE
1677
+ */
1678
+ export type MethodObjectSet = ObjectSet;
1679
+ /**
1680
+ * Computes the minimum value for the provided field.
1681
+ *
1682
+ * Log Safety: UNSAFE
1683
+ */
1684
+ export interface MinAggregation {
1685
+ field: FieldNameV1;
1686
+ name?: AggregationMetricName;
1687
+ }
1688
+ /**
1689
+ * Computes the minimum value for the provided field.
1690
+ *
1691
+ * Log Safety: UNSAFE
1692
+ */
1693
+ export interface MinAggregationV2 {
1694
+ field: PropertyApiName;
1695
+ name?: AggregationMetricName;
1696
+ direction?: OrderByDirection;
1697
+ }
1698
+ /**
1699
+ * Log Safety: UNSAFE
1700
+ */
1701
+ export interface ModifyInterfaceObjectRule {
1702
+ interfaceTypeApiName: InterfaceTypeApiName;
1703
+ }
1704
+ /**
1705
+ * Log Safety: UNSAFE
1706
+ */
1707
+ export interface ModifyObject {
1708
+ primaryKey: PropertyValue;
1709
+ objectType: ObjectTypeApiName;
1710
+ }
1711
+ /**
1712
+ * Log Safety: UNSAFE
1713
+ */
1714
+ export interface ModifyObjectRule {
1715
+ objectTypeApiName: ObjectTypeApiName;
1716
+ }
1717
+ /**
1718
+ * Queries support either a vector matching the embedding model defined on the property, or text that is
1719
+ automatically embedded.
1720
+ *
1721
+ * Log Safety: UNSAFE
1722
+ */
1723
+ export type NearestNeighborsQuery = ({
1724
+ type: "vector";
1725
+ } & DoubleVector) | ({
1726
+ type: "text";
1727
+ } & NearestNeighborsQueryText);
1728
+ /**
1729
+ * Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.
1730
+ *
1731
+ * Log Safety: UNSAFE
1732
+ */
1733
+ export interface NearestNeighborsQueryText {
1734
+ value: string;
1735
+ }
1736
+ /**
1737
+ * Log Safety: UNSAFE
1738
+ */
1739
+ export interface NestedQueryAggregation {
1740
+ key: any;
1741
+ groups: Array<QueryAggregation>;
1742
+ }
1743
+ /**
1744
+ * Returns objects where the query is not satisfied.
1745
+ *
1746
+ * Log Safety: UNSAFE
1747
+ */
1748
+ export interface NotQuery {
1749
+ value: SearchJsonQuery;
1750
+ }
1751
+ /**
1752
+ * Returns objects where the query is not satisfied.
1753
+ *
1754
+ * Log Safety: UNSAFE
1755
+ */
1756
+ export interface NotQueryV2 {
1757
+ value: SearchJsonQueryV2;
1758
+ }
1759
+ /**
1760
+ * Log Safety: UNSAFE
1761
+ */
1762
+ export type ObjectEdit = ({
1763
+ type: "modifyObject";
1764
+ } & ModifyObject) | ({
1765
+ type: "addObject";
1766
+ } & AddObject) | ({
1767
+ type: "addLink";
1768
+ } & AddLink);
1769
+ /**
1770
+ * Log Safety: UNSAFE
1771
+ */
1772
+ export interface ObjectEdits {
1773
+ edits: Array<ObjectEdit>;
1774
+ addedObjectCount: number;
1775
+ modifiedObjectsCount: number;
1776
+ deletedObjectsCount: number;
1777
+ addedLinksCount: number;
1778
+ deletedLinksCount: number;
1779
+ }
1780
+ /**
1781
+ * Log Safety: UNSAFE
1782
+ */
1783
+ export type ObjectPrimaryKey = Record<PropertyApiName, PropertyValue>;
1784
+ /**
1785
+ * A union of all the types supported by Ontology Object properties.
1786
+ *
1787
+ * Log Safety: UNSAFE
1788
+ */
1789
+ export type ObjectPropertyType = ({
1790
+ type: "date";
1791
+ } & _Core.DateType) | ({
1792
+ type: "struct";
1793
+ } & StructType) | ({
1794
+ type: "string";
1795
+ } & _Core.StringType) | ({
1796
+ type: "byte";
1797
+ } & _Core.ByteType) | ({
1798
+ type: "double";
1799
+ } & _Core.DoubleType) | ({
1800
+ type: "geopoint";
1801
+ } & _Core.GeoPointType) | ({
1802
+ type: "geotimeSeriesReference";
1803
+ } & _Core.GeotimeSeriesReferenceType) | ({
1804
+ type: "integer";
1805
+ } & _Core.IntegerType) | ({
1806
+ type: "float";
1807
+ } & _Core.FloatType) | ({
1808
+ type: "geoshape";
1809
+ } & _Core.GeoShapeType) | ({
1810
+ type: "long";
1811
+ } & _Core.LongType) | ({
1812
+ type: "boolean";
1813
+ } & _Core.BooleanType) | ({
1814
+ type: "cipherText";
1815
+ } & _Core.CipherTextType) | ({
1816
+ type: "marking";
1817
+ } & _Core.MarkingType) | ({
1818
+ type: "attachment";
1819
+ } & _Core.AttachmentType) | ({
1820
+ type: "mediaReference";
1821
+ } & _Core.MediaReferenceType) | ({
1822
+ type: "timeseries";
1823
+ } & _Core.TimeseriesType) | ({
1824
+ type: "array";
1825
+ } & OntologyObjectArrayType) | ({
1826
+ type: "short";
1827
+ } & _Core.ShortType) | ({
1828
+ type: "vector";
1829
+ } & _Core.VectorType) | ({
1830
+ type: "decimal";
1831
+ } & _Core.DecimalType) | ({
1832
+ type: "timestamp";
1833
+ } & _Core.TimestampType);
1834
+ /**
1835
+ * The parameter value must be a property value of an object found within an object set.
1836
+ *
1837
+ * Log Safety: SAFE
1838
+ */
1839
+ export interface ObjectPropertyValueConstraint {
1840
+ }
1841
+ /**
1842
+ * The parameter value must be the primary key of an object found within an object set.
1843
+ *
1844
+ * Log Safety: SAFE
1845
+ */
1846
+ export interface ObjectQueryResultConstraint {
1847
+ }
1848
+ /**
1849
+ * The unique resource identifier of an object, useful for interacting with other Foundry APIs.
1850
+ *
1851
+ * Log Safety: SAFE
1852
+ */
1853
+ export type ObjectRid = LooselyBrandedString<"ObjectRid">;
1854
+ /**
1855
+ * Represents the definition of an ObjectSet in the Ontology.
1856
+ *
1857
+ * Log Safety: UNSAFE
1858
+ */
1859
+ export type ObjectSet = ({
1860
+ type: "searchAround";
1861
+ } & ObjectSetSearchAroundType) | ({
1862
+ type: "static";
1863
+ } & ObjectSetStaticType) | ({
1864
+ type: "intersect";
1865
+ } & ObjectSetIntersectionType) | ({
1866
+ type: "withProperties";
1867
+ } & ObjectSetWithPropertiesType) | ({
1868
+ type: "subtract";
1869
+ } & ObjectSetSubtractType) | ({
1870
+ type: "nearestNeighbors";
1871
+ } & ObjectSetNearestNeighborsType) | ({
1872
+ type: "union";
1873
+ } & ObjectSetUnionType) | ({
1874
+ type: "asType";
1875
+ } & ObjectSetAsTypeType) | ({
1876
+ type: "methodInput";
1877
+ } & ObjectSetMethodInputType) | ({
1878
+ type: "reference";
1879
+ } & ObjectSetReferenceType) | ({
1880
+ type: "filter";
1881
+ } & ObjectSetFilterType) | ({
1882
+ type: "interfaceBase";
1883
+ } & ObjectSetInterfaceBaseType) | ({
1884
+ type: "asBaseObjectTypes";
1885
+ } & ObjectSetAsBaseObjectTypesType) | ({
1886
+ type: "base";
1887
+ } & ObjectSetBaseType);
1888
+ /**
1889
+ * Casts the objects in the object set to their base type and thus ensures objects are returned with all of their
1890
+ properties in the resulting object set, not just the properties that implement interface properties. This is
1891
+ currently unsupported and an exception will be thrown if used.
1892
+ *
1893
+ * Log Safety: UNSAFE
1894
+ */
1895
+ export interface ObjectSetAsBaseObjectTypesType {
1896
+ objectSet: ObjectSet;
1897
+ }
1898
+ /**
1899
+ * Casts an object set to a specified object type or interface type API name. Any object whose object type does
1900
+ not match the object type provided or implement the interface type provided will be dropped from the resulting
1901
+ object set. This is currently unsupported and an exception will be thrown if used.
1902
+ *
1903
+ * Log Safety: UNSAFE
1904
+ */
1905
+ export interface ObjectSetAsTypeType {
1906
+ entityType: string;
1907
+ objectSet: ObjectSet;
1908
+ }
1909
+ /**
1910
+ * Log Safety: UNSAFE
1911
+ */
1912
+ export interface ObjectSetBaseType {
1913
+ objectType: string;
1914
+ }
1915
+ /**
1916
+ * Log Safety: UNSAFE
1917
+ */
1918
+ export interface ObjectSetFilterType {
1919
+ objectSet: ObjectSet;
1920
+ where: SearchJsonQueryV2;
1921
+ }
1922
+ /**
1923
+ * Log Safety: UNSAFE
1924
+ */
1925
+ export interface ObjectSetInterfaceBaseType {
1926
+ interfaceType: string;
1927
+ }
1928
+ /**
1929
+ * Log Safety: UNSAFE
1930
+ */
1931
+ export interface ObjectSetIntersectionType {
1932
+ objectSets: Array<ObjectSet>;
1933
+ }
1934
+ /**
1935
+ * ObjectSet which is the root of a MethodObjectSet definition.
1936
+ This feature is experimental and not yet generally available.
1937
+ *
1938
+ * Log Safety: SAFE
1939
+ */
1940
+ export interface ObjectSetMethodInputType {
1941
+ }
1942
+ /**
1943
+ * ObjectSet containing the top numNeighbors objects with propertyIdentifier nearest to the input vector or
1944
+ text. This can only be performed on a property with type vector that has been configured to be searched with
1945
+ approximate nearest neighbors using a similarity function configured in the Ontology.
1946
+ A non-zero score for each resulting object is returned when the orderType in the orderBy field is set to
1947
+ relevance. Note that:
1948
+
1949
+ Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction
1950
+ or intersection with non-nearestNeighbors object sets.
1951
+ If results have scores, the order of the scores will be decreasing (duplicate scores are possible).
1952
+ *
1953
+ * Log Safety: UNSAFE
1954
+ */
1955
+ export interface ObjectSetNearestNeighborsType {
1956
+ objectSet: ObjectSet;
1957
+ propertyIdentifier: PropertyIdentifier;
1958
+ numNeighbors: number;
1959
+ query: NearestNeighborsQuery;
1960
+ }
1961
+ /**
1962
+ * Log Safety: SAFE
1963
+ */
1964
+ export interface ObjectSetReferenceType {
1965
+ reference: ObjectSetRid;
1966
+ }
1967
+ /**
1968
+ * Log Safety: SAFE
1969
+ */
1970
+ export type ObjectSetRid = LooselyBrandedString<"ObjectSetRid">;
1971
+ /**
1972
+ * Log Safety: UNSAFE
1973
+ */
1974
+ export interface ObjectSetSearchAroundType {
1975
+ objectSet: ObjectSet;
1976
+ link: LinkTypeApiName;
1977
+ }
1978
+ /**
1979
+ * Log Safety: SAFE
1980
+ */
1981
+ export interface ObjectSetStaticType {
1982
+ objects: Array<ObjectRid>;
1983
+ }
1984
+ /**
1985
+ * Log Safety: UNSAFE
1986
+ */
1987
+ export interface ObjectSetStreamSubscribeRequest {
1988
+ objectSet: ObjectSet;
1989
+ propertySet: Array<SelectedPropertyApiName>;
1990
+ referenceSet: Array<SelectedPropertyApiName>;
1991
+ }
1992
+ /**
1993
+ * The list of object sets that should be subscribed to. A client can stop subscribing to an object set
1994
+ by removing the request from subsequent ObjectSetStreamSubscribeRequests.
1995
+ *
1996
+ * Log Safety: UNSAFE
1997
+ */
1998
+ export interface ObjectSetStreamSubscribeRequests {
1999
+ id: RequestId;
2000
+ requests: Array<ObjectSetStreamSubscribeRequest>;
2001
+ }
2002
+ /**
2003
+ * Log Safety: UNSAFE
2004
+ */
2005
+ export type ObjectSetSubscribeResponse = ({
2006
+ type: "qos";
2007
+ } & QosError) | ({
2008
+ type: "success";
2009
+ } & SubscriptionSuccess) | ({
2010
+ type: "error";
2011
+ } & SubscriptionError);
2012
+ /**
2013
+ * Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.
2014
+ *
2015
+ * Log Safety: UNSAFE
2016
+ */
2017
+ export interface ObjectSetSubscribeResponses {
2018
+ responses: Array<ObjectSetSubscribeResponse>;
2019
+ id: RequestId;
2020
+ }
2021
+ /**
2022
+ * Log Safety: UNSAFE
2023
+ */
2024
+ export interface ObjectSetSubtractType {
2025
+ objectSets: Array<ObjectSet>;
2026
+ }
2027
+ /**
2028
+ * Log Safety: UNSAFE
2029
+ */
2030
+ export interface ObjectSetUnionType {
2031
+ objectSets: Array<ObjectSet>;
2032
+ }
2033
+ /**
2034
+ * Log Safety: UNSAFE
2035
+ */
2036
+ export type ObjectSetUpdate = ({
2037
+ type: "reference";
2038
+ } & ReferenceUpdate) | ({
2039
+ type: "object";
2040
+ } & ObjectUpdate);
2041
+ /**
2042
+ * Log Safety: UNSAFE
2043
+ */
2044
+ export interface ObjectSetUpdates {
2045
+ id: SubscriptionId;
2046
+ updates: Array<ObjectSetUpdate>;
2047
+ }
2048
+ /**
2049
+ * ObjectSet which returns objects with additional derived properties.
2050
+ This feature is experimental and not yet generally available.
2051
+ *
2052
+ * Log Safety: UNSAFE
2053
+ */
2054
+ export interface ObjectSetWithPropertiesType {
2055
+ objectSet: ObjectSet;
2056
+ derivedProperties: Record<DerivedPropertyApiName, DerivedPropertyDefinition>;
2057
+ }
2058
+ /**
2059
+ * Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was
2060
+ added to the set or the object has updated and was previously in the set. REMOVED indicates that the object
2061
+ was removed from the set due to the object being deleted or the object no longer meets the object set
2062
+ definition.
2063
+ *
2064
+ * Log Safety: SAFE
2065
+ */
2066
+ export type ObjectState = "ADDED_OR_UPDATED" | "REMOVED";
2067
+ /**
2068
+ * Represents an object type in the Ontology.
2069
+ *
2070
+ * Log Safety: UNSAFE
2071
+ */
2072
+ export interface ObjectType {
2073
+ apiName: ObjectTypeApiName;
2074
+ displayName?: _Core.DisplayName;
2075
+ status: _Core.ReleaseStatus;
2076
+ description?: string;
2077
+ visibility?: ObjectTypeVisibility;
2078
+ primaryKey: Array<PropertyApiName>;
2079
+ properties: Record<PropertyApiName, Property>;
2080
+ rid: ObjectTypeRid;
2081
+ }
2082
+ /**
2083
+ * The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the
2084
+ List object types endpoint or check the Ontology Manager.
2085
+ *
2086
+ * Log Safety: UNSAFE
2087
+ */
2088
+ export type ObjectTypeApiName = LooselyBrandedString<"ObjectTypeApiName">;
2089
+ /**
2090
+ * Log Safety: UNSAFE
2091
+ */
2092
+ export interface ObjectTypeEdits {
2093
+ editedObjectTypes: Array<ObjectTypeApiName>;
2094
+ }
2095
+ /**
2096
+ * Log Safety: UNSAFE
2097
+ */
2098
+ export interface ObjectTypeFullMetadata {
2099
+ objectType: ObjectTypeV2;
2100
+ linkTypes: Array<LinkTypeSideV2>;
2101
+ implementsInterfaces: Array<InterfaceTypeApiName>;
2102
+ implementsInterfaces2: Record<InterfaceTypeApiName, ObjectTypeInterfaceImplementation>;
2103
+ sharedPropertyTypeMapping: Record<SharedPropertyTypeApiName, PropertyApiName>;
2104
+ }
2105
+ /**
2106
+ * Log Safety: UNSAFE
2107
+ */
2108
+ export interface ObjectTypeInterfaceImplementation {
2109
+ properties: Record<SharedPropertyTypeApiName, PropertyApiName>;
2110
+ }
2111
+ /**
2112
+ * The unique resource identifier of an object type, useful for interacting with other Foundry APIs.
2113
+ *
2114
+ * Log Safety: SAFE
2115
+ */
2116
+ export type ObjectTypeRid = LooselyBrandedString<"ObjectTypeRid">;
2117
+ /**
2118
+ * Represents an object type in the Ontology.
2119
+ *
2120
+ * Log Safety: UNSAFE
2121
+ */
2122
+ export interface ObjectTypeV2 {
2123
+ apiName: ObjectTypeApiName;
2124
+ displayName: _Core.DisplayName;
2125
+ status: _Core.ReleaseStatus;
2126
+ description?: string;
2127
+ pluralDisplayName: string;
2128
+ icon: Icon;
2129
+ primaryKey: PropertyApiName;
2130
+ properties: Record<PropertyApiName, PropertyV2>;
2131
+ rid: ObjectTypeRid;
2132
+ titleProperty: PropertyApiName;
2133
+ visibility?: ObjectTypeVisibility;
2134
+ }
2135
+ /**
2136
+ * The suggested visibility of the object type.
2137
+ *
2138
+ * Log Safety: SAFE
2139
+ */
2140
+ export type ObjectTypeVisibility = "NORMAL" | "PROMINENT" | "HIDDEN";
2141
+ /**
2142
+ * Log Safety: UNSAFE
2143
+ */
2144
+ export interface ObjectUpdate {
2145
+ object: OntologyObjectV2;
2146
+ state: ObjectState;
2147
+ }
2148
+ /**
2149
+ * The parameter has a manually predefined set of options.
2150
+ *
2151
+ * Log Safety: UNSAFE
2152
+ */
2153
+ export interface OneOfConstraint {
2154
+ options: Array<ParameterOption>;
2155
+ otherValuesAllowed: boolean;
2156
+ }
2157
+ /**
2158
+ * Metadata about an Ontology.
2159
+ *
2160
+ * Log Safety: UNSAFE
2161
+ */
2162
+ export interface Ontology {
2163
+ apiName: OntologyApiName;
2164
+ displayName: _Core.DisplayName;
2165
+ description: string;
2166
+ rid: OntologyRid;
2167
+ }
2168
+ /**
2169
+ * Log Safety: UNSAFE
2170
+ */
2171
+ export type OntologyApiName = LooselyBrandedString<"OntologyApiName">;
2172
+ /**
2173
+ * Log Safety: UNSAFE
2174
+ */
2175
+ export interface OntologyArrayType {
2176
+ itemType: OntologyDataType;
2177
+ }
2178
+ /**
2179
+ * A union of all the primitive types used by Palantir's Ontology-based products.
2180
+ *
2181
+ * Log Safety: UNSAFE
2182
+ */
2183
+ export type OntologyDataType = ({
2184
+ type: "date";
2185
+ } & _Core.DateType) | ({
2186
+ type: "struct";
2187
+ } & OntologyStructType) | ({
2188
+ type: "set";
2189
+ } & OntologySetType) | ({
2190
+ type: "string";
2191
+ } & _Core.StringType) | ({
2192
+ type: "byte";
2193
+ } & _Core.ByteType) | ({
2194
+ type: "double";
2195
+ } & _Core.DoubleType) | ({
2196
+ type: "integer";
2197
+ } & _Core.IntegerType) | ({
2198
+ type: "float";
2199
+ } & _Core.FloatType) | ({
2200
+ type: "any";
2201
+ } & _Core.AnyType) | ({
2202
+ type: "long";
2203
+ } & _Core.LongType) | ({
2204
+ type: "boolean";
2205
+ } & _Core.BooleanType) | ({
2206
+ type: "cipherText";
2207
+ } & _Core.CipherTextType) | ({
2208
+ type: "marking";
2209
+ } & _Core.MarkingType) | ({
2210
+ type: "unsupported";
2211
+ } & _Core.UnsupportedType) | ({
2212
+ type: "array";
2213
+ } & OntologyArrayType) | ({
2214
+ type: "objectSet";
2215
+ } & OntologyObjectSetType) | ({
2216
+ type: "binary";
2217
+ } & _Core.BinaryType) | ({
2218
+ type: "short";
2219
+ } & _Core.ShortType) | ({
2220
+ type: "decimal";
2221
+ } & _Core.DecimalType) | ({
2222
+ type: "map";
2223
+ } & OntologyMapType) | ({
2224
+ type: "timestamp";
2225
+ } & _Core.TimestampType) | ({
2226
+ type: "object";
2227
+ } & OntologyObjectType);
2228
+ /**
2229
+ * Log Safety: UNSAFE
2230
+ */
2231
+ export interface OntologyFullMetadata {
2232
+ ontology: OntologyV2;
2233
+ objectTypes: Record<ObjectTypeApiName, ObjectTypeFullMetadata>;
2234
+ actionTypes: Record<ActionTypeApiName, ActionTypeV2>;
2235
+ queryTypes: Record<QueryApiName, QueryTypeV2>;
2236
+ interfaceTypes: Record<InterfaceTypeApiName, InterfaceType>;
2237
+ sharedPropertyTypes: Record<SharedPropertyTypeApiName, SharedPropertyType>;
2238
+ }
2239
+ /**
2240
+ * Either an ontology rid or an ontology api name.
2241
+ *
2242
+ * Log Safety: UNSAFE
2243
+ */
2244
+ export type OntologyIdentifier = LooselyBrandedString<"OntologyIdentifier">;
2245
+ /**
2246
+ * Log Safety: UNSAFE
2247
+ */
2248
+ export type OntologyInterface = LooselyBrandedString<"OntologyInterface">;
2249
+ /**
2250
+ * Log Safety: UNSAFE
2251
+ */
2252
+ export interface OntologyInterfaceObjectType {
2253
+ interfaceTypeApiName: InterfaceTypeApiName;
2254
+ }
2255
+ /**
2256
+ * Log Safety: UNSAFE
2257
+ */
2258
+ export interface OntologyMapType {
2259
+ keyType: OntologyDataType;
2260
+ valueType: OntologyDataType;
2261
+ }
2262
+ /**
2263
+ * Represents an object in the Ontology.
2264
+ *
2265
+ * Log Safety: UNSAFE
2266
+ */
2267
+ export interface OntologyObject {
2268
+ properties: Record<PropertyApiName, PropertyValue | undefined>;
2269
+ rid: ObjectRid;
2270
+ }
2271
+ /**
2272
+ * Log Safety: UNSAFE
2273
+ */
2274
+ export interface OntologyObjectArrayType {
2275
+ subType: ObjectPropertyType;
2276
+ }
2277
+ /**
2278
+ * Log Safety: UNSAFE
2279
+ */
2280
+ export type OntologyObjectSet = LooselyBrandedString<"OntologyObjectSet">;
2281
+ /**
2282
+ * Log Safety: UNSAFE
2283
+ */
2284
+ export interface OntologyObjectSetType {
2285
+ objectApiName?: ObjectTypeApiName;
2286
+ objectTypeApiName?: ObjectTypeApiName;
2287
+ }
2288
+ /**
2289
+ * Log Safety: UNSAFE
2290
+ */
2291
+ export interface OntologyObjectType {
2292
+ objectApiName: ObjectTypeApiName;
2293
+ objectTypeApiName: ObjectTypeApiName;
2294
+ }
2295
+ /**
2296
+ * Log Safety: SAFE
2297
+ */
2298
+ export interface OntologyObjectTypeReferenceType {
2299
+ }
2300
+ /**
2301
+ * Represents an object in the Ontology.
2302
+ *
2303
+ * Log Safety: UNSAFE
2304
+ */
2305
+ export type OntologyObjectV2 = Record<PropertyApiName, PropertyValue>;
2306
+ /**
2307
+ * The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the
2308
+ List ontologies endpoint or check the Ontology Manager.
2309
+ *
2310
+ * Log Safety: SAFE
2311
+ */
2312
+ export type OntologyRid = LooselyBrandedString<"OntologyRid">;
2313
+ /**
2314
+ * Log Safety: UNSAFE
2315
+ */
2316
+ export interface OntologySetType {
2317
+ itemType: OntologyDataType;
2318
+ }
2319
+ /**
2320
+ * Log Safety: UNSAFE
2321
+ */
2322
+ export interface OntologyStructField {
2323
+ name: _Core.StructFieldName;
2324
+ fieldType: OntologyDataType;
2325
+ required: boolean;
2326
+ }
2327
+ /**
2328
+ * Log Safety: UNSAFE
2329
+ */
2330
+ export interface OntologyStructType {
2331
+ fields: Array<OntologyStructField>;
2332
+ }
2333
+ /**
2334
+ * Metadata about an Ontology.
2335
+ *
2336
+ * Log Safety: UNSAFE
2337
+ */
2338
+ export interface OntologyV2 {
2339
+ apiName: OntologyApiName;
2340
+ displayName: _Core.DisplayName;
2341
+ description: string;
2342
+ rid: OntologyRid;
2343
+ }
2344
+ /**
2345
+ * A command representing the list of properties to order by. Properties should be delimited by commas and
2346
+ prefixed by p or properties. The format expected format is
2347
+ orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...
2348
+ By default, the ordering for a property is ascending, and this can be explicitly specified by appending
2349
+ :asc (for ascending) or :desc (for descending).
2350
+ Example: use orderBy=properties.lastName:asc to order by a single property,
2351
+ orderBy=properties.lastName,properties.firstName,properties.age:desc to order by multiple properties.
2352
+ You may also use the shorthand p instead of properties such as orderBy=p.lastName:asc.
2353
+ *
2354
+ * Log Safety: UNSAFE
2355
+ */
2356
+ export type OrderBy = LooselyBrandedString<"OrderBy">;
2357
+ /**
2358
+ * Log Safety: SAFE
2359
+ */
2360
+ export type OrderByDirection = "ASC" | "DESC";
2361
+ /**
2362
+ * Returns objects where at least 1 query is satisfied.
2363
+ *
2364
+ * Log Safety: UNSAFE
2365
+ */
2366
+ export interface OrQuery {
2367
+ value: Array<SearchJsonQuery>;
2368
+ }
2369
+ /**
2370
+ * Returns objects where at least 1 query is satisfied.
2371
+ *
2372
+ * Log Safety: UNSAFE
2373
+ */
2374
+ export interface OrQueryV2 {
2375
+ value: Array<SearchJsonQueryV2>;
2376
+ }
2377
+ /**
2378
+ * Details about a parameter of an action or query.
2379
+ *
2380
+ * Log Safety: UNSAFE
2381
+ */
2382
+ export interface Parameter {
2383
+ description?: string;
2384
+ baseType: ValueType;
2385
+ dataType?: OntologyDataType;
2386
+ required: boolean;
2387
+ }
2388
+ /**
2389
+ * A constraint that an action parameter value must satisfy in order to be considered valid.
2390
+ Constraints can be configured on action parameters in the Ontology Manager.
2391
+ Applicable constraints are determined dynamically based on parameter inputs.
2392
+ Parameter values are evaluated against the final set of constraints.
2393
+ The type of the constraint.
2394
+ | Type | Description |
2395
+ |-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2396
+ | arraySize | The parameter expects an array of values and the size of the array must fall within the defined range. |
2397
+ | groupMember | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |
2398
+ | objectPropertyValue | The parameter value must be a property value of an object found within an object set. |
2399
+ | objectQueryResult | The parameter value must be the primary key of an object found within an object set. |
2400
+ | oneOf | The parameter has a manually predefined set of options. |
2401
+ | range | The parameter value must be within the defined range. |
2402
+ | stringLength | The parameter value must have a length within the defined range. |
2403
+ | stringRegexMatch | The parameter value must match a predefined regular expression. |
2404
+ | unevaluable | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |
2405
+ *
2406
+ * Log Safety: UNSAFE
2407
+ */
2408
+ export type ParameterEvaluatedConstraint = ({
2409
+ type: "oneOf";
2410
+ } & OneOfConstraint) | ({
2411
+ type: "groupMember";
2412
+ } & GroupMemberConstraint) | ({
2413
+ type: "objectPropertyValue";
2414
+ } & ObjectPropertyValueConstraint) | ({
2415
+ type: "range";
2416
+ } & RangeConstraint) | ({
2417
+ type: "arraySize";
2418
+ } & ArraySizeConstraint) | ({
2419
+ type: "objectQueryResult";
2420
+ } & ObjectQueryResultConstraint) | ({
2421
+ type: "stringLength";
2422
+ } & StringLengthConstraint) | ({
2423
+ type: "stringRegexMatch";
2424
+ } & StringRegexMatchConstraint) | ({
2425
+ type: "unevaluable";
2426
+ } & UnevaluableConstraint);
2427
+ /**
2428
+ * Represents the validity of a parameter against the configured constraints.
2429
+ *
2430
+ * Log Safety: UNSAFE
2431
+ */
2432
+ export interface ParameterEvaluationResult {
2433
+ result: ValidationResult;
2434
+ evaluatedConstraints: Array<ParameterEvaluatedConstraint>;
2435
+ required: boolean;
2436
+ }
2437
+ /**
2438
+ * The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.
2439
+ Parameters can be viewed and managed in the Ontology Manager.
2440
+ *
2441
+ * Log Safety: UNSAFE
2442
+ */
2443
+ export type ParameterId = LooselyBrandedString<"ParameterId">;
2444
+ /**
2445
+ * A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.
2446
+ *
2447
+ * Log Safety: UNSAFE
2448
+ */
2449
+ export interface ParameterOption {
2450
+ displayName?: _Core.DisplayName;
2451
+ value?: any;
2452
+ }
2453
+ /**
2454
+ * Returns objects where the specified field contains the provided value as a substring.
2455
+ *
2456
+ * Log Safety: UNSAFE
2457
+ */
2458
+ export interface PhraseQuery {
2459
+ field: FieldNameV1;
2460
+ value: string;
2461
+ }
2462
+ /**
2463
+ * Log Safety: UNSAFE
2464
+ */
2465
+ export type PolygonValue = {
2466
+ type: "Polygon";
2467
+ } & _Geo.Polygon;
2468
+ /**
2469
+ * Returns objects where the specified field starts with the provided value.
2470
+ *
2471
+ * Log Safety: UNSAFE
2472
+ */
2473
+ export interface PrefixQuery {
2474
+ field: FieldNameV1;
2475
+ value: string;
2476
+ }
2477
+ /**
2478
+ * Represents the primary key value that is used as a unique identifier for an object.
2479
+ *
2480
+ * Log Safety: UNSAFE
2481
+ */
2482
+ export type PrimaryKeyValue = any;
2483
+ /**
2484
+ * Details about some property of an object.
2485
+ *
2486
+ * Log Safety: UNSAFE
2487
+ */
2488
+ export interface Property {
2489
+ description?: string;
2490
+ displayName?: _Core.DisplayName;
2491
+ baseType: ValueType;
2492
+ }
2493
+ /**
2494
+ * The name of the property in the API. To find the API name for your property, use the Get object type
2495
+ endpoint or check the Ontology Manager.
2496
+ *
2497
+ * Log Safety: UNSAFE
2498
+ */
2499
+ export type PropertyApiName = LooselyBrandedString<"PropertyApiName">;
2500
+ /**
2501
+ * A property api name that references properties to query on.
2502
+ *
2503
+ * Log Safety: UNSAFE
2504
+ */
2505
+ export interface PropertyApiNameSelector {
2506
+ apiName: PropertyApiName;
2507
+ }
2508
+ /**
2509
+ * Represents a filter used on properties.
2510
+ Endpoints that accept this supports optional parameters that have the form:
2511
+ properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString} to filter the returned objects.
2512
+ For instance, you may use properties.firstName.eq=John to find objects that contain a property called
2513
+ "firstName" that has the exact value of "John".
2514
+ The following are a list of supported property filters:
2515
+
2516
+ properties.{propertyApiName}.contains - supported on arrays and can be used to filter array properties
2517
+ that have at least one of the provided values. If multiple query parameters are provided, then objects
2518
+ that have any of the given values for the specified property will be matched.
2519
+ properties.{propertyApiName}.eq - used to filter objects that have the exact value for the provided
2520
+ property. If multiple query parameters are provided, then objects that have any of the given values
2521
+ will be matched. For instance, if the user provides a request by doing
2522
+ ?properties.firstName.eq=John&properties.firstName.eq=Anna, then objects that have a firstName property
2523
+ of either John or Anna will be matched. This filter is supported on all property types except Arrays.
2524
+ properties.{propertyApiName}.neq - used to filter objects that do not have the provided property values.
2525
+ Similar to the eq filter, if multiple values are provided, then objects that have any of the given values
2526
+ will be excluded from the result.
2527
+ properties.{propertyApiName}.lt, properties.{propertyApiName}.lte, properties.{propertyApiName}.gt
2528
+ properties.{propertyApiName}.gte - represent less than, less than or equal to, greater than, and greater
2529
+ than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.
2530
+ properties.{propertyApiName}.isNull - used to filter objects where the provided property is (or is not) null.
2531
+ This filter is supported on all property types.
2532
+ *
2533
+ * Log Safety: SAFE
2534
+ */
2535
+ export type PropertyFilter = LooselyBrandedString<"PropertyFilter">;
2536
+ /**
2537
+ * The immutable ID of a property. Property IDs are only used to identify properties in the Ontology Manager
2538
+ application and assign them API names. In every other case, API names should be used instead of property IDs.
2539
+ *
2540
+ * Log Safety: UNSAFE
2541
+ */
2542
+ export type PropertyId = LooselyBrandedString<"PropertyId">;
2543
+ /**
2544
+ * An identifier used to select properties or struct fields.
2545
+ *
2546
+ * Log Safety: UNSAFE
2547
+ */
2548
+ export type PropertyIdentifier = ({
2549
+ type: "property";
2550
+ } & PropertyApiNameSelector) | ({
2551
+ type: "structField";
2552
+ } & StructFieldSelector);
2553
+ /**
2554
+ * Log Safety: SAFE
2555
+ */
2556
+ export type PropertyTypeRid = LooselyBrandedString<"PropertyTypeRid">;
2557
+ /**
2558
+ * The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.
2559
+ *
2560
+ * Log Safety: UNSAFE
2561
+ */
2562
+ export type PropertyTypeStatus = ({
2563
+ type: "deprecated";
2564
+ } & DeprecatedPropertyTypeStatus) | ({
2565
+ type: "active";
2566
+ } & ActivePropertyTypeStatus) | ({
2567
+ type: "experimental";
2568
+ } & ExperimentalPropertyTypeStatus) | ({
2569
+ type: "example";
2570
+ } & ExamplePropertyTypeStatus);
2571
+ /**
2572
+ * Log Safety: SAFE
2573
+ */
2574
+ export type PropertyTypeVisibility = "NORMAL" | "PROMINENT" | "HIDDEN";
2575
+ /**
2576
+ * Details about some property of an object.
2577
+ *
2578
+ * Log Safety: UNSAFE
2579
+ */
2580
+ export interface PropertyV2 {
2581
+ description?: string;
2582
+ displayName?: _Core.DisplayName;
2583
+ dataType: ObjectPropertyType;
2584
+ rid: PropertyTypeRid;
2585
+ status?: PropertyTypeStatus;
2586
+ visibility?: PropertyTypeVisibility;
2587
+ }
2588
+ /**
2589
+ * Represents the value of a property in the following format.
2590
+ | Type | JSON encoding | Example |
2591
+ |---------------- |-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
2592
+ | Array | array | ["alpha", "bravo", "charlie"] |
2593
+ | Attachment | JSON encoded AttachmentProperty object | {"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"} |
2594
+ | Boolean | boolean | true |
2595
+ | Byte | number | 31 |
2596
+ | CipherText | string | "CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER" |
2597
+
2598
+ | Date | ISO 8601 extended local date string | "2021-05-01" |
2599
+ | Decimal | string | "2.718281828" |
2600
+ | Double | number | 3.14159265 |
2601
+ | Float | number | 3.14159265 |
2602
+ | GeoPoint | geojson | {"type":"Point","coordinates":[102.0,0.5]} |
2603
+ | GeoShape | geojson | {"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |
2604
+ | Integer | number | 238940 |
2605
+ | Long | string | "58319870951433" |
2606
+ | MediaReference | JSON encoded MediaReference object | {"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}} |
2607
+ | Short | number | 8739 |
2608
+ | String | string | "Call me Ishmael" |
2609
+ | Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} |
2610
+ | Timestamp | ISO 8601 extended offset date-time string in UTC zone | "2021-01-04T05:00:00Z" |
2611
+ | Timeseries | JSON encoded TimeseriesProperty object or seriesId string | {"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"} or {"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"} or "wellPressureSeriesId"| |
2612
+ Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
2613
+ *
2614
+ * Log Safety: UNSAFE
2615
+ */
2616
+ export type PropertyValue = any;
2617
+ /**
2618
+ * Represents the value of a property in string format. This is used in URL parameters.
2619
+ *
2620
+ * Log Safety: UNSAFE
2621
+ */
2622
+ export type PropertyValueEscapedString = LooselyBrandedString<"PropertyValueEscapedString">;
2623
+ /**
2624
+ * An error indicating that the subscribe request should be attempted on a different node.
2625
+ *
2626
+ * Log Safety: SAFE
2627
+ */
2628
+ export interface QosError {
2629
+ }
2630
+ /**
2631
+ * The representation of a time series property backed by multiple time series syncs.
2632
+ *
2633
+ * Log Safety: UNSAFE
2634
+ */
2635
+ export interface QualifiedTimeseriesProperty {
2636
+ seriesId: SeriesId;
2637
+ syncRid: TimeseriesSyncRid;
2638
+ }
2639
+ /**
2640
+ * Log Safety: UNSAFE
2641
+ */
2642
+ export type Query = LooselyBrandedString<"Query">;
2643
+ /**
2644
+ * Log Safety: UNSAFE
2645
+ */
2646
+ export interface QueryAggregation {
2647
+ key: any;
2648
+ value: any;
2649
+ }
2650
+ /**
2651
+ * A union of all the types supported by query aggregation keys.
2652
+ *
2653
+ * Log Safety: UNSAFE
2654
+ */
2655
+ export type QueryAggregationKeyType = ({
2656
+ type: "date";
2657
+ } & _Core.DateType) | ({
2658
+ type: "boolean";
2659
+ } & _Core.BooleanType) | ({
2660
+ type: "string";
2661
+ } & _Core.StringType) | ({
2662
+ type: "double";
2663
+ } & _Core.DoubleType) | ({
2664
+ type: "range";
2665
+ } & QueryAggregationRangeType) | ({
2666
+ type: "integer";
2667
+ } & _Core.IntegerType) | ({
2668
+ type: "timestamp";
2669
+ } & _Core.TimestampType);
2670
+ /**
2671
+ * Specifies a range from an inclusive start value to an exclusive end value.
2672
+ *
2673
+ * Log Safety: UNSAFE
2674
+ */
2675
+ export interface QueryAggregationRange {
2676
+ startValue?: any;
2677
+ endValue?: any;
2678
+ }
2679
+ /**
2680
+ * A union of all the types supported by query aggregation ranges.
2681
+ *
2682
+ * Log Safety: UNSAFE
2683
+ */
2684
+ export type QueryAggregationRangeSubType = ({
2685
+ type: "date";
2686
+ } & _Core.DateType) | ({
2687
+ type: "double";
2688
+ } & _Core.DoubleType) | ({
2689
+ type: "integer";
2690
+ } & _Core.IntegerType) | ({
2691
+ type: "timestamp";
2692
+ } & _Core.TimestampType);
2693
+ /**
2694
+ * Log Safety: UNSAFE
2695
+ */
2696
+ export interface QueryAggregationRangeType {
2697
+ subType: QueryAggregationRangeSubType;
2698
+ }
2699
+ /**
2700
+ * A union of all the types supported by query aggregation keys.
2701
+ *
2702
+ * Log Safety: UNSAFE
2703
+ */
2704
+ export type QueryAggregationValueType = ({
2705
+ type: "date";
2706
+ } & _Core.DateType) | ({
2707
+ type: "double";
2708
+ } & _Core.DoubleType) | ({
2709
+ type: "timestamp";
2710
+ } & _Core.TimestampType);
2711
+ /**
2712
+ * The name of the Query in the API.
2713
+ *
2714
+ * Log Safety: UNSAFE
2715
+ */
2716
+ export type QueryApiName = LooselyBrandedString<"QueryApiName">;
2717
+ /**
2718
+ * Log Safety: UNSAFE
2719
+ */
2720
+ export interface QueryArrayType {
2721
+ subType: QueryDataType;
2722
+ }
2723
+ /**
2724
+ * A union of all the types supported by Ontology Query parameters or outputs.
2725
+ *
2726
+ * Log Safety: UNSAFE
2727
+ */
2728
+ export type QueryDataType = ({
2729
+ type: "date";
2730
+ } & _Core.DateType) | ({
2731
+ type: "struct";
2732
+ } & QueryStructType) | ({
2733
+ type: "set";
2734
+ } & QuerySetType) | ({
2735
+ type: "string";
2736
+ } & _Core.StringType) | ({
2737
+ type: "double";
2738
+ } & _Core.DoubleType) | ({
2739
+ type: "integer";
2740
+ } & _Core.IntegerType) | ({
2741
+ type: "threeDimensionalAggregation";
2742
+ } & ThreeDimensionalAggregation) | ({
2743
+ type: "union";
2744
+ } & QueryUnionType) | ({
2745
+ type: "float";
2746
+ } & _Core.FloatType) | ({
2747
+ type: "long";
2748
+ } & _Core.LongType) | ({
2749
+ type: "boolean";
2750
+ } & _Core.BooleanType) | ({
2751
+ type: "unsupported";
2752
+ } & _Core.UnsupportedType) | ({
2753
+ type: "attachment";
2754
+ } & _Core.AttachmentType) | ({
2755
+ type: "null";
2756
+ } & _Core.NullType) | ({
2757
+ type: "array";
2758
+ } & QueryArrayType) | ({
2759
+ type: "objectSet";
2760
+ } & OntologyObjectSetType) | ({
2761
+ type: "twoDimensionalAggregation";
2762
+ } & TwoDimensionalAggregation) | ({
2763
+ type: "object";
2764
+ } & OntologyObjectType) | ({
2765
+ type: "timestamp";
2766
+ } & _Core.TimestampType);
2767
+ /**
2768
+ * Details about the output of a query.
2769
+ *
2770
+ * Log Safety: UNSAFE
2771
+ */
2772
+ export interface QueryOutputV2 {
2773
+ dataType: QueryDataType;
2774
+ required: boolean;
2775
+ }
2776
+ /**
2777
+ * Details about a parameter of a query.
2778
+ *
2779
+ * Log Safety: UNSAFE
2780
+ */
2781
+ export interface QueryParameterV2 {
2782
+ description?: string;
2783
+ dataType: QueryDataType;
2784
+ }
2785
+ /**
2786
+ * Log Safety: UNSAFE
2787
+ */
2788
+ export type QueryRuntimeErrorParameter = LooselyBrandedString<"QueryRuntimeErrorParameter">;
2789
+ /**
2790
+ * Log Safety: UNSAFE
2791
+ */
2792
+ export interface QuerySetType {
2793
+ subType: QueryDataType;
2794
+ }
2795
+ /**
2796
+ * Log Safety: UNSAFE
2797
+ */
2798
+ export interface QueryStructField {
2799
+ name: _Core.StructFieldName;
2800
+ fieldType: QueryDataType;
2801
+ }
2802
+ /**
2803
+ * Log Safety: UNSAFE
2804
+ */
2805
+ export interface QueryStructType {
2806
+ fields: Array<QueryStructField>;
2807
+ }
2808
+ /**
2809
+ * Log Safety: UNSAFE
2810
+ */
2811
+ export interface QueryThreeDimensionalAggregation {
2812
+ groups: Array<NestedQueryAggregation>;
2813
+ }
2814
+ /**
2815
+ * Log Safety: UNSAFE
2816
+ */
2817
+ export interface QueryTwoDimensionalAggregation {
2818
+ groups: Array<QueryAggregation>;
2819
+ }
2820
+ /**
2821
+ * Represents a query type in the Ontology.
2822
+ *
2823
+ * Log Safety: UNSAFE
2824
+ */
2825
+ export interface QueryType {
2826
+ apiName: QueryApiName;
2827
+ description?: string;
2828
+ displayName?: _Core.DisplayName;
2829
+ parameters: Record<ParameterId, Parameter>;
2830
+ output?: OntologyDataType;
2831
+ rid: FunctionRid;
2832
+ version: FunctionVersion;
2833
+ }
2834
+ /**
2835
+ * Represents a query type in the Ontology.
2836
+ *
2837
+ * Log Safety: UNSAFE
2838
+ */
2839
+ export interface QueryTypeV2 {
2840
+ apiName: QueryApiName;
2841
+ description?: string;
2842
+ displayName?: _Core.DisplayName;
2843
+ parameters: Record<ParameterId, QueryParameterV2>;
2844
+ output: QueryDataType;
2845
+ rid: FunctionRid;
2846
+ version: FunctionVersion;
2847
+ }
2848
+ /**
2849
+ * Log Safety: UNSAFE
2850
+ */
2851
+ export interface QueryUnionType {
2852
+ unionTypes: Array<QueryDataType>;
2853
+ }
2854
+ /**
2855
+ * The parameter value must be within the defined range.
2856
+ *
2857
+ * Log Safety: UNSAFE
2858
+ */
2859
+ export interface RangeConstraint {
2860
+ lt?: any;
2861
+ lte?: any;
2862
+ gt?: any;
2863
+ gte?: any;
2864
+ }
2865
+ /**
2866
+ * Log Safety: SAFE
2867
+ */
2868
+ export interface Reason {
2869
+ reason: ReasonType;
2870
+ }
2871
+ /**
2872
+ * Represents the reason a subscription was closed.
2873
+ *
2874
+ * Log Safety: SAFE
2875
+ */
2876
+ export type ReasonType = "USER_CLOSED" | "CHANNEL_CLOSED";
2877
+ /**
2878
+ * The updated data value associated with an object instance's external reference. The object instance
2879
+ is uniquely identified by an object type and a primary key. Note that the value of the property
2880
+ field returns a dereferenced value rather than the reference itself.
2881
+ *
2882
+ * Log Safety: UNSAFE
2883
+ */
2884
+ export interface ReferenceUpdate {
2885
+ objectType: ObjectTypeApiName;
2886
+ primaryKey: ObjectPrimaryKey;
2887
+ property: PropertyApiName;
2888
+ value: ReferenceValue;
2889
+ }
2890
+ /**
2891
+ * Resolved data values pointed to by a reference.
2892
+ *
2893
+ * Log Safety: UNSAFE
2894
+ */
2895
+ export type ReferenceValue = {
2896
+ type: "geotimeSeriesValue";
2897
+ } & GeotimeSeriesValue;
2898
+ /**
2899
+ * The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.
2900
+ *
2901
+ * Log Safety: UNSAFE
2902
+ */
2903
+ export interface RefreshObjectSet {
2904
+ id: SubscriptionId;
2905
+ objectType: ObjectTypeApiName;
2906
+ }
2907
+ /**
2908
+ * A relative time, such as "3 days before" or "2 hours after" the current moment.
2909
+ *
2910
+ * Log Safety: UNSAFE
2911
+ */
2912
+ export interface RelativeTime {
2913
+ when: RelativeTimeRelation;
2914
+ value: number;
2915
+ unit: RelativeTimeSeriesTimeUnit;
2916
+ }
2917
+ /**
2918
+ * A relative time range for a time series query.
2919
+ *
2920
+ * Log Safety: UNSAFE
2921
+ */
2922
+ export interface RelativeTimeRange {
2923
+ startTime?: RelativeTime;
2924
+ endTime?: RelativeTime;
2925
+ }
2926
+ /**
2927
+ * Log Safety: SAFE
2928
+ */
2929
+ export type RelativeTimeRelation = "BEFORE" | "AFTER";
2930
+ /**
2931
+ * Log Safety: SAFE
2932
+ */
2933
+ export type RelativeTimeSeriesTimeUnit = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS";
2934
+ /**
2935
+ * Unique request id
2936
+ *
2937
+ * Log Safety: SAFE
2938
+ */
2939
+ export type RequestId = string;
2940
+ /**
2941
+ * Log Safety: SAFE
2942
+ */
2943
+ export type ReturnEditsMode = "ALL" | "NONE";
2944
+ /**
2945
+ * Log Safety: UNSAFE
2946
+ */
2947
+ export type SdkPackageName = LooselyBrandedString<"SdkPackageName">;
2948
+ /**
2949
+ * Log Safety: UNSAFE
2950
+ */
2951
+ export type SearchJsonQuery = ({
2952
+ type: "or";
2953
+ } & OrQuery) | ({
2954
+ type: "prefix";
2955
+ } & PrefixQuery) | ({
2956
+ type: "lt";
2957
+ } & LtQuery) | ({
2958
+ type: "allTerms";
2959
+ } & AllTermsQuery) | ({
2960
+ type: "eq";
2961
+ } & EqualsQuery) | ({
2962
+ type: "gt";
2963
+ } & GtQuery) | ({
2964
+ type: "contains";
2965
+ } & ContainsQuery) | ({
2966
+ type: "not";
2967
+ } & NotQuery) | ({
2968
+ type: "phrase";
2969
+ } & PhraseQuery) | ({
2970
+ type: "and";
2971
+ } & AndQuery) | ({
2972
+ type: "isNull";
2973
+ } & IsNullQuery) | ({
2974
+ type: "gte";
2975
+ } & GteQuery) | ({
2976
+ type: "anyTerm";
2977
+ } & AnyTermQuery) | ({
2978
+ type: "lte";
2979
+ } & LteQuery);
2980
+ /**
2981
+ * Log Safety: UNSAFE
2982
+ */
2983
+ export type SearchJsonQueryV2 = ({
2984
+ type: "or";
2985
+ } & OrQueryV2) | ({
2986
+ type: "in";
2987
+ } & InQuery) | ({
2988
+ type: "doesNotIntersectPolygon";
2989
+ } & DoesNotIntersectPolygonQuery) | ({
2990
+ type: "lt";
2991
+ } & LtQueryV2) | ({
2992
+ type: "doesNotIntersectBoundingBox";
2993
+ } & DoesNotIntersectBoundingBoxQuery) | ({
2994
+ type: "eq";
2995
+ } & EqualsQueryV2) | ({
2996
+ type: "containsAllTerms";
2997
+ } & ContainsAllTermsQuery) | ({
2998
+ type: "gt";
2999
+ } & GtQueryV2) | ({
3000
+ type: "withinDistanceOf";
3001
+ } & WithinDistanceOfQuery) | ({
3002
+ type: "withinBoundingBox";
3003
+ } & WithinBoundingBoxQuery) | ({
3004
+ type: "contains";
3005
+ } & ContainsQueryV2) | ({
3006
+ type: "not";
3007
+ } & NotQueryV2) | ({
3008
+ type: "intersectsBoundingBox";
3009
+ } & IntersectsBoundingBoxQuery) | ({
3010
+ type: "and";
3011
+ } & AndQueryV2) | ({
3012
+ type: "isNull";
3013
+ } & IsNullQueryV2) | ({
3014
+ type: "containsAllTermsInOrderPrefixLastTerm";
3015
+ } & ContainsAllTermsInOrderPrefixLastTerm) | ({
3016
+ type: "containsAnyTerm";
3017
+ } & ContainsAnyTermQuery) | ({
3018
+ type: "gte";
3019
+ } & GteQueryV2) | ({
3020
+ type: "containsAllTermsInOrder";
3021
+ } & ContainsAllTermsInOrderQuery) | ({
3022
+ type: "withinPolygon";
3023
+ } & WithinPolygonQuery) | ({
3024
+ type: "intersectsPolygon";
3025
+ } & IntersectsPolygonQuery) | ({
3026
+ type: "lte";
3027
+ } & LteQueryV2) | ({
3028
+ type: "startsWith";
3029
+ } & StartsWithQuery);
3030
+ /**
3031
+ * Log Safety: UNSAFE
3032
+ */
3033
+ export interface SearchObjectsForInterfaceRequest {
3034
+ where?: SearchJsonQueryV2;
3035
+ orderBy?: SearchOrderByV2;
3036
+ augmentedProperties: Record<ObjectTypeApiName, Array<PropertyApiName>>;
3037
+ augmentedSharedPropertyTypes: Record<InterfaceTypeApiName, Array<SharedPropertyTypeApiName>>;
3038
+ selectedSharedPropertyTypes: Array<SharedPropertyTypeApiName>;
3039
+ selectedObjectTypes: Array<ObjectTypeApiName>;
3040
+ otherInterfaceTypes: Array<InterfaceTypeApiName>;
3041
+ pageSize?: _Core.PageSize;
3042
+ pageToken?: _Core.PageToken;
3043
+ }
3044
+ /**
3045
+ * Log Safety: UNSAFE
3046
+ */
3047
+ export interface SearchObjectsRequest {
3048
+ query: SearchJsonQuery;
3049
+ orderBy?: SearchOrderBy;
3050
+ pageSize?: _Core.PageSize;
3051
+ pageToken?: _Core.PageToken;
3052
+ fields: Array<PropertyApiName>;
3053
+ }
3054
+ /**
3055
+ * Log Safety: UNSAFE
3056
+ */
3057
+ export interface SearchObjectsRequestV2 {
3058
+ where?: SearchJsonQueryV2;
3059
+ orderBy?: SearchOrderByV2;
3060
+ pageSize?: _Core.PageSize;
3061
+ pageToken?: _Core.PageToken;
3062
+ select: Array<PropertyApiName>;
3063
+ excludeRid?: boolean;
3064
+ }
3065
+ /**
3066
+ * Log Safety: UNSAFE
3067
+ */
3068
+ export interface SearchObjectsResponse {
3069
+ data: Array<OntologyObject>;
3070
+ nextPageToken?: _Core.PageToken;
3071
+ totalCount: _Core.TotalCount;
3072
+ }
3073
+ /**
3074
+ * Log Safety: UNSAFE
3075
+ */
3076
+ export interface SearchObjectsResponseV2 {
3077
+ data: Array<OntologyObjectV2>;
3078
+ nextPageToken?: _Core.PageToken;
3079
+ totalCount: _Core.TotalCount;
3080
+ }
3081
+ /**
3082
+ * Specifies the ordering of search results by a field and an ordering direction.
3083
+ *
3084
+ * Log Safety: UNSAFE
3085
+ */
3086
+ export interface SearchOrderBy {
3087
+ fields: Array<SearchOrdering>;
3088
+ }
3089
+ /**
3090
+ * Log Safety: SAFE
3091
+ */
3092
+ export type SearchOrderByType = "fields" | "relevance";
3093
+ /**
3094
+ * Specifies the ordering of search results by a field and an ordering direction or by relevance if scores are required in a nearestNeighbors query. By default orderType is set to fields.
3095
+ *
3096
+ * Log Safety: UNSAFE
3097
+ */
3098
+ export interface SearchOrderByV2 {
3099
+ orderType?: SearchOrderByType;
3100
+ fields: Array<SearchOrderingV2>;
3101
+ }
3102
+ /**
3103
+ * Log Safety: UNSAFE
3104
+ */
3105
+ export interface SearchOrdering {
3106
+ field: FieldNameV1;
3107
+ direction?: string;
3108
+ }
3109
+ /**
3110
+ * Log Safety: UNSAFE
3111
+ */
3112
+ export interface SearchOrderingV2 {
3113
+ field: PropertyApiName;
3114
+ direction?: string;
3115
+ }
3116
+ /**
3117
+ * By default, anytime an object is requested, every property belonging to that object is returned.
3118
+ The response can be filtered to only include certain properties using the properties query parameter.
3119
+ Properties to include can be specified in one of two ways.
3120
+
3121
+ A comma delimited list as the value for the properties query parameter
3122
+ properties={property1ApiName},{property2ApiName}
3123
+ Multiple properties query parameters.
3124
+ properties={property1ApiName}&properties={property2ApiName}
3125
+
3126
+ The primary key of the object will always be returned even if it wasn't specified in the properties values.
3127
+ Unknown properties specified in the properties list will result in a PropertiesNotFound error.
3128
+ To find the API name for your property, use the Get object type endpoint or check the Ontology Manager.
3129
+ *
3130
+ * Log Safety: UNSAFE
3131
+ */
3132
+ export type SelectedPropertyApiName = LooselyBrandedString<"SelectedPropertyApiName">;
3133
+ /**
3134
+ * Computes an approximate number of distinct values for the provided field.
3135
+ *
3136
+ * Log Safety: UNSAFE
3137
+ */
3138
+ export interface SelectedPropertyApproximateDistinctAggregation {
3139
+ selectedPropertyApiName: PropertyApiName;
3140
+ }
3141
+ /**
3142
+ * Computes the approximate percentile value for the provided field.
3143
+ *
3144
+ * Log Safety: UNSAFE
3145
+ */
3146
+ export interface SelectedPropertyApproximatePercentileAggregation {
3147
+ selectedPropertyApiName: PropertyApiName;
3148
+ approximatePercentile: number;
3149
+ }
3150
+ /**
3151
+ * Computes the average value for the provided field.
3152
+ *
3153
+ * Log Safety: UNSAFE
3154
+ */
3155
+ export interface SelectedPropertyAvgAggregation {
3156
+ selectedPropertyApiName: PropertyApiName;
3157
+ }
3158
+ /**
3159
+ * Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.
3160
+ NOTE: A separate count aggregation should be used to determine the total count of values, to account for
3161
+ a possible truncation of the returned list.
3162
+ Ignores objects for which a property is absent, so the returned list will contain non-null values only.
3163
+ Returns an empty list when none of the objects have values for a provided property.
3164
+ *
3165
+ * Log Safety: UNSAFE
3166
+ */
3167
+ export interface SelectedPropertyCollectListAggregation {
3168
+ selectedPropertyApiName: PropertyApiName;
3169
+ limit: number;
3170
+ }
3171
+ /**
3172
+ * Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.
3173
+ NOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of
3174
+ values, to account for a possible truncation of the returned set.
3175
+ Ignores objects for which a property is absent, so the returned list will contain non-null values only.
3176
+ Returns an empty list when none of the objects have values for a provided property.
3177
+ *
3178
+ * Log Safety: UNSAFE
3179
+ */
3180
+ export interface SelectedPropertyCollectSetAggregation {
3181
+ selectedPropertyApiName: PropertyApiName;
3182
+ limit: number;
3183
+ }
3184
+ /**
3185
+ * Computes the total count of objects.
3186
+ *
3187
+ * Log Safety: SAFE
3188
+ */
3189
+ export interface SelectedPropertyCountAggregation {
3190
+ }
3191
+ /**
3192
+ * Definition for a selected property over a MethodObjectSet.
3193
+ *
3194
+ * Log Safety: UNSAFE
3195
+ */
3196
+ export interface SelectedPropertyDefinition {
3197
+ objectSet: MethodObjectSet;
3198
+ operation: SelectedPropertyOperation;
3199
+ }
3200
+ /**
3201
+ * Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.
3202
+ *
3203
+ * Log Safety: UNSAFE
3204
+ */
3205
+ export interface SelectedPropertyExactDistinctAggregation {
3206
+ selectedPropertyApiName: PropertyApiName;
3207
+ }
3208
+ /**
3209
+ * Computes the maximum value for the provided field.
3210
+ *
3211
+ * Log Safety: UNSAFE
3212
+ */
3213
+ export interface SelectedPropertyMaxAggregation {
3214
+ selectedPropertyApiName: PropertyApiName;
3215
+ }
3216
+ /**
3217
+ * Computes the minimum value for the provided field.
3218
+ *
3219
+ * Log Safety: UNSAFE
3220
+ */
3221
+ export interface SelectedPropertyMinAggregation {
3222
+ selectedPropertyApiName: PropertyApiName;
3223
+ }
3224
+ /**
3225
+ * Operation on a selected property, can be an aggregation function or retrieval of a single selected property
3226
+ *
3227
+ * Log Safety: UNSAFE
3228
+ */
3229
+ export type SelectedPropertyOperation = ({
3230
+ type: "approximateDistinct";
3231
+ } & SelectedPropertyApproximateDistinctAggregation) | ({
3232
+ type: "min";
3233
+ } & SelectedPropertyMinAggregation) | ({
3234
+ type: "avg";
3235
+ } & SelectedPropertyAvgAggregation) | ({
3236
+ type: "max";
3237
+ } & SelectedPropertyMaxAggregation) | ({
3238
+ type: "approximatePercentile";
3239
+ } & SelectedPropertyApproximatePercentileAggregation) | ({
3240
+ type: "get";
3241
+ } & GetSelectedPropertyOperation) | ({
3242
+ type: "count";
3243
+ } & SelectedPropertyCountAggregation) | ({
3244
+ type: "sum";
3245
+ } & SelectedPropertySumAggregation) | ({
3246
+ type: "collectList";
3247
+ } & SelectedPropertyCollectListAggregation) | ({
3248
+ type: "exactDistinct";
3249
+ } & SelectedPropertyExactDistinctAggregation) | ({
3250
+ type: "collectSet";
3251
+ } & SelectedPropertyCollectSetAggregation);
3252
+ /**
3253
+ * Computes the sum of values for the provided field.
3254
+ *
3255
+ * Log Safety: UNSAFE
3256
+ */
3257
+ export interface SelectedPropertySumAggregation {
3258
+ selectedPropertyApiName: PropertyApiName;
3259
+ }
3260
+ /**
3261
+ * The unique codex id of a time series.
3262
+ *
3263
+ * Log Safety: UNSAFE
3264
+ */
3265
+ export type SeriesId = LooselyBrandedString<"SeriesId">;
3266
+ /**
3267
+ * A property type that can be shared across object types.
3268
+ *
3269
+ * Log Safety: UNSAFE
3270
+ */
3271
+ export interface SharedPropertyType {
3272
+ rid: SharedPropertyTypeRid;
3273
+ apiName: SharedPropertyTypeApiName;
3274
+ displayName: _Core.DisplayName;
3275
+ description?: string;
3276
+ dataType: ObjectPropertyType;
3277
+ }
3278
+ /**
3279
+ * The name of the shared property type in the API in lowerCamelCase format. To find the API name for your
3280
+ shared property type, use the List shared property types endpoint or check the Ontology Manager.
3281
+ *
3282
+ * Log Safety: UNSAFE
3283
+ */
3284
+ export type SharedPropertyTypeApiName = LooselyBrandedString<"SharedPropertyTypeApiName">;
3285
+ /**
3286
+ * The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.
3287
+ *
3288
+ * Log Safety: SAFE
3289
+ */
3290
+ export type SharedPropertyTypeRid = LooselyBrandedString<"SharedPropertyTypeRid">;
3291
+ /**
3292
+ * Returns objects where the specified field starts with the provided value. Allows you to specify a property to
3293
+ query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.
3294
+ *
3295
+ * Log Safety: UNSAFE
3296
+ */
3297
+ export interface StartsWithQuery {
3298
+ field?: PropertyApiName;
3299
+ propertyIdentifier?: PropertyIdentifier;
3300
+ value: string;
3301
+ }
3302
+ /**
3303
+ * Which format to serialize the binary stream in.
3304
+ ARROW is more efficient for streaming a large sized response.
3305
+ *
3306
+ * Log Safety: SAFE
3307
+ */
3308
+ export type StreamingOutputFormat = "JSON" | "ARROW";
3309
+ /**
3310
+ * Log Safety: UNSAFE
3311
+ */
3312
+ export type StreamMessage = ({
3313
+ type: "objectSetChanged";
3314
+ } & ObjectSetUpdates) | ({
3315
+ type: "refreshObjectSet";
3316
+ } & RefreshObjectSet) | ({
3317
+ type: "subscriptionClosed";
3318
+ } & SubscriptionClosed) | ({
3319
+ type: "subscribeResponses";
3320
+ } & ObjectSetSubscribeResponses);
3321
+ /**
3322
+ * Log Safety: UNSAFE
3323
+ */
3324
+ export interface StreamTimeSeriesPointsRequest {
3325
+ range?: TimeRange;
3326
+ }
3327
+ /**
3328
+ * Log Safety: UNSAFE
3329
+ */
3330
+ export interface StreamTimeSeriesPointsResponse {
3331
+ data: Array<TimeSeriesPoint>;
3332
+ }
3333
+ /**
3334
+ * Log Safety: UNSAFE
3335
+ */
3336
+ export interface StreamTimeSeriesValuesRequest {
3337
+ range?: TimeRange;
3338
+ }
3339
+ /**
3340
+ * Log Safety: UNSAFE
3341
+ */
3342
+ export interface StreamTimeSeriesValuesResponse {
3343
+ data: Array<TimeseriesEntry>;
3344
+ }
3345
+ /**
3346
+ * The parameter value must have a length within the defined range.
3347
+ This range is always inclusive.
3348
+ *
3349
+ * Log Safety: UNSAFE
3350
+ */
3351
+ export interface StringLengthConstraint {
3352
+ lt?: any;
3353
+ lte?: any;
3354
+ gt?: any;
3355
+ gte?: any;
3356
+ }
3357
+ /**
3358
+ * The parameter value must match a predefined regular expression.
3359
+ *
3360
+ * Log Safety: UNSAFE
3361
+ */
3362
+ export interface StringRegexMatchConstraint {
3363
+ regex: string;
3364
+ configuredFailureMessage?: string;
3365
+ }
3366
+ /**
3367
+ * The name of a struct field in the Ontology.
3368
+ *
3369
+ * Log Safety: UNSAFE
3370
+ */
3371
+ export type StructFieldApiName = LooselyBrandedString<"StructFieldApiName">;
3372
+ /**
3373
+ * A combination of a struct property api name and a struct field api name. This is used to select struct fields
3374
+ to query on. Note that you can still select struct properties with only a 'PropertyApiNameSelector'; the queries
3375
+ will then become 'OR' queries across the fields of the struct property.
3376
+ *
3377
+ * Log Safety: UNSAFE
3378
+ */
3379
+ export interface StructFieldSelector {
3380
+ propertyApiName: PropertyApiName;
3381
+ structFieldApiName: StructFieldApiName;
3382
+ }
3383
+ /**
3384
+ * Log Safety: UNSAFE
3385
+ */
3386
+ export interface StructFieldType {
3387
+ apiName: StructFieldApiName;
3388
+ dataType: ObjectPropertyType;
3389
+ }
3390
+ /**
3391
+ * Log Safety: UNSAFE
3392
+ */
3393
+ export interface StructType {
3394
+ structFieldTypes: Array<StructFieldType>;
3395
+ }
3396
+ /**
3397
+ * Contains the status of the submission criteria.
3398
+ Submission criteria are the prerequisites that need to be satisfied before an Action can be applied.
3399
+ These are configured in the Ontology Manager.
3400
+ *
3401
+ * Log Safety: UNSAFE
3402
+ */
3403
+ export interface SubmissionCriteriaEvaluation {
3404
+ configuredFailureMessage?: string;
3405
+ result: ValidationResult;
3406
+ }
3407
+ /**
3408
+ * The subscription has been closed due to an irrecoverable error during its lifecycle.
3409
+ *
3410
+ * Log Safety: UNSAFE
3411
+ */
3412
+ export interface SubscriptionClosed {
3413
+ id: SubscriptionId;
3414
+ cause: SubscriptionClosureCause;
3415
+ }
3416
+ /**
3417
+ * Log Safety: UNSAFE
3418
+ */
3419
+ export type SubscriptionClosureCause = ({
3420
+ type: "reason";
3421
+ } & Reason) | ({
3422
+ type: "error";
3423
+ } & Error);
3424
+ /**
3425
+ * Log Safety: UNSAFE
3426
+ */
3427
+ export interface SubscriptionError {
3428
+ errors: Array<Error>;
3429
+ }
3430
+ /**
3431
+ * A unique identifier used to associate subscription requests with responses.
3432
+ *
3433
+ * Log Safety: SAFE
3434
+ */
3435
+ export type SubscriptionId = string;
3436
+ /**
3437
+ * Log Safety: SAFE
3438
+ */
3439
+ export interface SubscriptionSuccess {
3440
+ id: SubscriptionId;
3441
+ }
3442
+ /**
3443
+ * Computes the sum of values for the provided field.
3444
+ *
3445
+ * Log Safety: UNSAFE
3446
+ */
3447
+ export interface SumAggregation {
3448
+ field: FieldNameV1;
3449
+ name?: AggregationMetricName;
3450
+ }
3451
+ /**
3452
+ * Computes the sum of values for the provided field.
3453
+ *
3454
+ * Log Safety: UNSAFE
3455
+ */
3456
+ export interface SumAggregationV2 {
3457
+ field: PropertyApiName;
3458
+ name?: AggregationMetricName;
3459
+ direction?: OrderByDirection;
3460
+ }
3461
+ /**
3462
+ * Log Safety: UNSAFE
3463
+ */
3464
+ export interface SyncApplyActionResponseV2 {
3465
+ validation?: ValidateActionResponseV2;
3466
+ edits?: ActionResults;
3467
+ }
3468
+ /**
3469
+ * Log Safety: UNSAFE
3470
+ */
3471
+ export interface ThreeDimensionalAggregation {
3472
+ keyType: QueryAggregationKeyType;
3473
+ valueType: TwoDimensionalAggregation;
3474
+ }
3475
+ /**
3476
+ * An absolute or relative range for a time series query.
3477
+ *
3478
+ * Log Safety: UNSAFE
3479
+ */
3480
+ export type TimeRange = ({
3481
+ type: "absolute";
3482
+ } & AbsoluteTimeRange) | ({
3483
+ type: "relative";
3484
+ } & RelativeTimeRange);
3485
+ /**
3486
+ * A time and value pair.
3487
+ *
3488
+ * Log Safety: UNSAFE
3489
+ */
3490
+ export interface TimeseriesEntry {
3491
+ time: string;
3492
+ value: any;
3493
+ }
3494
+ /**
3495
+ * A time and value pair.
3496
+ *
3497
+ * Log Safety: UNSAFE
3498
+ */
3499
+ export interface TimeSeriesPoint {
3500
+ time: string;
3501
+ value: any;
3502
+ }
3503
+ /**
3504
+ * Log Safety: UNSAFE
3505
+ */
3506
+ export type TimeSeriesPropertyV2 = LooselyBrandedString<"TimeSeriesPropertyV2">;
3507
+ /**
3508
+ * The RID identifying a time series sync.
3509
+ *
3510
+ * Log Safety: SAFE
3511
+ */
3512
+ export type TimeseriesSyncRid = LooselyBrandedString<"TimeseriesSyncRid">;
3513
+ /**
3514
+ * The RID identifying a time series codex template that resolves to a derived series.
3515
+ *
3516
+ * Log Safety: SAFE
3517
+ */
3518
+ export type TimeseriesTemplateRid = LooselyBrandedString<"TimeseriesTemplateRid">;
3519
+ /**
3520
+ * The version corresponding to a codex template.
3521
+ *
3522
+ * Log Safety: UNSAFE
3523
+ */
3524
+ export type TimeseriesTemplateVersion = LooselyBrandedString<"TimeseriesTemplateVersion">;
3525
+ /**
3526
+ * Log Safety: UNSAFE
3527
+ */
3528
+ export type TimeSeriesValueBankProperty = LooselyBrandedString<"TimeSeriesValueBankProperty">;
3529
+ /**
3530
+ * Log Safety: SAFE
3531
+ */
3532
+ export type TimeUnit = "MILLISECONDS" | "SECONDS" | "MINUTES" | "HOURS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "QUARTERS";
3533
+ /**
3534
+ * Log Safety: UNSAFE
3535
+ */
3536
+ export interface TwoDimensionalAggregation {
3537
+ keyType: QueryAggregationKeyType;
3538
+ valueType: QueryAggregationValueType;
3539
+ }
3540
+ /**
3541
+ * The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.
3542
+ This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.
3543
+ *
3544
+ * Log Safety: SAFE
3545
+ */
3546
+ export interface UnevaluableConstraint {
3547
+ }
3548
+ /**
3549
+ * Log Safety: UNSAFE
3550
+ */
3551
+ export interface ValidateActionRequest {
3552
+ parameters: Record<ParameterId, DataValue | undefined>;
3553
+ }
3554
+ /**
3555
+ * Log Safety: UNSAFE
3556
+ */
3557
+ export interface ValidateActionResponse {
3558
+ result: ValidationResult;
3559
+ submissionCriteria: Array<SubmissionCriteriaEvaluation>;
3560
+ parameters: Record<ParameterId, ParameterEvaluationResult>;
3561
+ }
3562
+ /**
3563
+ * Log Safety: UNSAFE
3564
+ */
3565
+ export interface ValidateActionResponseV2 {
3566
+ result: ValidationResult;
3567
+ submissionCriteria: Array<SubmissionCriteriaEvaluation>;
3568
+ parameters: Record<ParameterId, ParameterEvaluationResult>;
3569
+ }
3570
+ /**
3571
+ * Represents the state of a validation.
3572
+ *
3573
+ * Log Safety: SAFE
3574
+ */
3575
+ export type ValidationResult = "VALID" | "INVALID";
3576
+ /**
3577
+ * A string indicating the type of each data value. Note that these types can be nested, for example an array of
3578
+ structs.
3579
+ | Type | JSON value |
3580
+ |---------------------|-------------------------------------------------------------------------------------------------------------------|
3581
+ | Array | Array<T>, where T is the type of the array elements, e.g. Array<String>. |
3582
+ | Attachment | Attachment |
3583
+ | Boolean | Boolean |
3584
+ | Byte | Byte |
3585
+ | CipherText | CipherText |
3586
+ | Date | LocalDate |
3587
+ | Decimal | Decimal |
3588
+ | Double | Double |
3589
+ | Float | Float |
3590
+ | Integer | Integer |
3591
+ | Long | Long |
3592
+ | Marking | Marking |
3593
+ | OntologyObject | OntologyObject<T> where T is the API name of the referenced object type. |
3594
+ | Short | Short |
3595
+ | String | String |
3596
+ | Struct | Struct<T> where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> |
3597
+ | Timeseries | TimeSeries<T> where T is either String for an enum series or Double for a numeric series. |
3598
+ | Timestamp | Timestamp |
3599
+ *
3600
+ * Log Safety: SAFE
3601
+ */
3602
+ export type ValueType = LooselyBrandedString<"ValueType">;
3603
+ /**
3604
+ * Log Safety: UNSAFE
3605
+ */
3606
+ export type WithinBoundingBoxPoint = {
3607
+ type: "Point";
3608
+ } & _Geo.GeoPoint;
3609
+ /**
3610
+ * Returns objects where the specified field contains a point within the bounding box provided. Allows you to
3611
+ specify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,
3612
+ but not both.
3613
+ *
3614
+ * Log Safety: UNSAFE
3615
+ */
3616
+ export interface WithinBoundingBoxQuery {
3617
+ field?: PropertyApiName;
3618
+ propertyIdentifier?: PropertyIdentifier;
3619
+ value: BoundingBoxValue;
3620
+ }
3621
+ /**
3622
+ * Returns objects where the specified field contains a point within the distance provided of the center point.
3623
+ Allows you to specify a property to query on by a variety of means. Either field or propertyIdentifier
3624
+ must be supplied, but not both.
3625
+ *
3626
+ * Log Safety: UNSAFE
3627
+ */
3628
+ export interface WithinDistanceOfQuery {
3629
+ field?: PropertyApiName;
3630
+ propertyIdentifier?: PropertyIdentifier;
3631
+ value: CenterPoint;
3632
+ }
3633
+ /**
3634
+ * Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a
3635
+ property to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not
3636
+ both.
3637
+ *
3638
+ * Log Safety: UNSAFE
3639
+ */
3640
+ export interface WithinPolygonQuery {
3641
+ field?: PropertyApiName;
3642
+ propertyIdentifier?: PropertyIdentifier;
3643
+ value: PolygonValue;
3644
+ }
4
3645
  //# sourceMappingURL=_components.d.ts.map