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