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