@osdk/foundry.ontologies 2.31.0 → 2.33.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 +25 -0
- package/build/browser/_components.d.ts +297 -18
- package/build/browser/_components.d.ts.map +1 -1
- package/build/browser/_errors.d.ts +124 -0
- package/build/browser/_errors.d.ts.map +1 -1
- package/build/browser/index.d.ts +2 -1
- package/build/browser/index.d.ts.map +1 -1
- package/build/browser/index.js +1 -0
- package/build/browser/index.js.map +1 -1
- package/build/browser/public/ActionTypeFullMetadata.d.ts +20 -0
- package/build/browser/public/ActionTypeFullMetadata.d.ts.map +1 -0
- package/build/browser/public/ActionTypeFullMetadata.js +30 -0
- package/build/browser/public/ActionTypeFullMetadata.js.map +1 -0
- package/build/browser/public/OntologyV2.d.ts +2 -0
- package/build/browser/public/OntologyV2.d.ts.map +1 -1
- package/build/browser/public/OntologyV2.js +2 -0
- package/build/browser/public/OntologyV2.js.map +1 -1
- package/build/browser/public/OntologyValueType.d.ts +2 -2
- package/build/browser/public/OntologyValueType.js +2 -2
- package/build/browser/public/OntologyValueType.js.map +1 -1
- package/build/esm/_components.d.ts +297 -18
- package/build/esm/_components.d.ts.map +1 -1
- package/build/esm/_errors.d.ts +124 -0
- package/build/esm/_errors.d.ts.map +1 -1
- package/build/esm/index.d.ts +2 -1
- package/build/esm/index.d.ts.map +1 -1
- package/build/esm/index.js +1 -0
- package/build/esm/index.js.map +1 -1
- package/build/esm/public/ActionTypeFullMetadata.d.ts +20 -0
- package/build/esm/public/ActionTypeFullMetadata.d.ts.map +1 -0
- package/build/esm/public/ActionTypeFullMetadata.js +30 -0
- package/build/esm/public/ActionTypeFullMetadata.js.map +1 -0
- package/build/esm/public/OntologyV2.d.ts +2 -0
- package/build/esm/public/OntologyV2.d.ts.map +1 -1
- package/build/esm/public/OntologyV2.js +2 -0
- package/build/esm/public/OntologyV2.js.map +1 -1
- package/build/esm/public/OntologyValueType.d.ts +2 -2
- package/build/esm/public/OntologyValueType.js +2 -2
- package/build/esm/public/OntologyValueType.js.map +1 -1
- package/package.json +5 -5
package/build/esm/_errors.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export type LooselyBrandedString<T extends string> = string & {
|
|
|
9
9
|
export interface ActionContainsDuplicateEdits {
|
|
10
10
|
errorCode: "CONFLICT";
|
|
11
11
|
errorName: "ActionContainsDuplicateEdits";
|
|
12
|
+
errorDescription: "The given action request has multiple edits on the same object.";
|
|
12
13
|
errorInstanceId: string;
|
|
13
14
|
parameters: {};
|
|
14
15
|
}
|
|
@@ -21,6 +22,7 @@ Please contact the Ontology administrator to resolve this issue.
|
|
|
21
22
|
export interface ActionEditedPropertiesNotFound {
|
|
22
23
|
errorCode: "INVALID_ARGUMENT";
|
|
23
24
|
errorName: "ActionEditedPropertiesNotFound";
|
|
25
|
+
errorDescription: "Actions attempted to edit properties that could not be found on the object type. Please contact the Ontology administrator to resolve this issue.";
|
|
24
26
|
errorInstanceId: string;
|
|
25
27
|
parameters: {};
|
|
26
28
|
}
|
|
@@ -32,6 +34,7 @@ export interface ActionEditedPropertiesNotFound {
|
|
|
32
34
|
export interface ActionEditsReadOnlyEntity {
|
|
33
35
|
errorCode: "INVALID_ARGUMENT";
|
|
34
36
|
errorName: "ActionEditsReadOnlyEntity";
|
|
37
|
+
errorDescription: "The given action request performs edits on a type that is read-only or does not allow edits.";
|
|
35
38
|
errorInstanceId: string;
|
|
36
39
|
parameters: {
|
|
37
40
|
entityTypeRid: unknown;
|
|
@@ -45,6 +48,7 @@ export interface ActionEditsReadOnlyEntity {
|
|
|
45
48
|
export interface ActionNotFound {
|
|
46
49
|
errorCode: "NOT_FOUND";
|
|
47
50
|
errorName: "ActionNotFound";
|
|
51
|
+
errorDescription: "The action is not found, or the user does not have access to it.";
|
|
48
52
|
errorInstanceId: string;
|
|
49
53
|
parameters: {
|
|
50
54
|
actionRid: unknown;
|
|
@@ -58,6 +62,7 @@ export interface ActionNotFound {
|
|
|
58
62
|
export interface ActionParameterInterfaceTypeNotFound {
|
|
59
63
|
errorCode: "NOT_FOUND";
|
|
60
64
|
errorName: "ActionParameterInterfaceTypeNotFound";
|
|
65
|
+
errorDescription: "The parameter references an interface type that could not be found, or the client token does not have access to it.";
|
|
61
66
|
errorInstanceId: string;
|
|
62
67
|
parameters: {
|
|
63
68
|
parameterId: unknown;
|
|
@@ -71,6 +76,7 @@ export interface ActionParameterInterfaceTypeNotFound {
|
|
|
71
76
|
export interface ActionParameterObjectNotFound {
|
|
72
77
|
errorCode: "NOT_FOUND";
|
|
73
78
|
errorName: "ActionParameterObjectNotFound";
|
|
79
|
+
errorDescription: "The parameter object reference or parameter default value is not found, or the client token does not have access to it.";
|
|
74
80
|
errorInstanceId: string;
|
|
75
81
|
parameters: {
|
|
76
82
|
parameterId: unknown;
|
|
@@ -84,6 +90,7 @@ export interface ActionParameterObjectNotFound {
|
|
|
84
90
|
export interface ActionParameterObjectTypeNotFound {
|
|
85
91
|
errorCode: "NOT_FOUND";
|
|
86
92
|
errorName: "ActionParameterObjectTypeNotFound";
|
|
93
|
+
errorDescription: "The parameter references an object type that could not be found, or the client token does not have access to it.";
|
|
87
94
|
errorInstanceId: string;
|
|
88
95
|
parameters: {
|
|
89
96
|
parameterId: unknown;
|
|
@@ -97,6 +104,7 @@ export interface ActionParameterObjectTypeNotFound {
|
|
|
97
104
|
export interface ActionTypeNotFound {
|
|
98
105
|
errorCode: "NOT_FOUND";
|
|
99
106
|
errorName: "ActionTypeNotFound";
|
|
107
|
+
errorDescription: "The action type is not found, or the user does not have access to it.";
|
|
100
108
|
errorInstanceId: string;
|
|
101
109
|
parameters: {
|
|
102
110
|
actionType: unknown;
|
|
@@ -112,6 +120,7 @@ details.
|
|
|
112
120
|
export interface ActionValidationFailed {
|
|
113
121
|
errorCode: "INVALID_ARGUMENT";
|
|
114
122
|
errorName: "ActionValidationFailed";
|
|
123
|
+
errorDescription: "The validation failed for the given action parameters. Please use the validateAction endpoint for more details.";
|
|
115
124
|
errorInstanceId: string;
|
|
116
125
|
parameters: {
|
|
117
126
|
actionType: unknown;
|
|
@@ -126,6 +135,7 @@ Try allowing approximate results or adjust your aggregation request.
|
|
|
126
135
|
export interface AggregationAccuracyNotSupported {
|
|
127
136
|
errorCode: "INVALID_ARGUMENT";
|
|
128
137
|
errorName: "AggregationAccuracyNotSupported";
|
|
138
|
+
errorDescription: "The given aggregation cannot be performed with the requested accuracy. Try allowing approximate results or adjust your aggregation request.";
|
|
129
139
|
errorInstanceId: string;
|
|
130
140
|
parameters: {};
|
|
131
141
|
}
|
|
@@ -142,6 +152,7 @@ to reduce the number of groups.
|
|
|
142
152
|
export interface AggregationGroupCountExceededLimit {
|
|
143
153
|
errorCode: "INVALID_ARGUMENT";
|
|
144
154
|
errorName: "AggregationGroupCountExceededLimit";
|
|
155
|
+
errorDescription: "The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by adjusting your query to reduce the number of groups created by your aggregation. For instance: If you are using multiple groupBy clauses, try reducing the number of clauses. If you are using a groupBy clause with a high cardinality property, try filtering the data first to reduce the number of groups.";
|
|
145
156
|
errorInstanceId: string;
|
|
146
157
|
parameters: {
|
|
147
158
|
groupsCount: unknown;
|
|
@@ -161,6 +172,7 @@ to reduce the number of groups.
|
|
|
161
172
|
export interface AggregationMemoryExceededLimit {
|
|
162
173
|
errorCode: "INVALID_ARGUMENT";
|
|
163
174
|
errorName: "AggregationMemoryExceededLimit";
|
|
175
|
+
errorDescription: "The amount of memory used in the request exceeded the limit. This can typically be fixed by adjusting your query to reduce the number of groups created by your aggregation. For instance: If you are using multiple groupBy clauses, try reducing the number of clauses. If you are using a groupBy clause with a high cardinality property, try filtering the data first to reduce the number of groups.";
|
|
164
176
|
errorInstanceId: string;
|
|
165
177
|
parameters: {
|
|
166
178
|
memoryUsedBytes: unknown;
|
|
@@ -176,6 +188,7 @@ This can be fixed by aggregating over fewer objects, such as by applying a filte
|
|
|
176
188
|
export interface AggregationNestedObjectSetSizeExceededLimit {
|
|
177
189
|
errorCode: "INVALID_ARGUMENT";
|
|
178
190
|
errorName: "AggregationNestedObjectSetSizeExceededLimit";
|
|
191
|
+
errorDescription: "A nested object set within the aggregation exceeded the allowed limit. This can be fixed by aggregating over fewer objects, such as by applying a filter.";
|
|
179
192
|
errorInstanceId: string;
|
|
180
193
|
parameters: {
|
|
181
194
|
objectsCount: unknown;
|
|
@@ -188,6 +201,7 @@ export interface AggregationNestedObjectSetSizeExceededLimit {
|
|
|
188
201
|
export interface ApplyActionFailed {
|
|
189
202
|
errorCode: "INVALID_ARGUMENT";
|
|
190
203
|
errorName: "ApplyActionFailed";
|
|
204
|
+
errorDescription: "";
|
|
191
205
|
errorInstanceId: string;
|
|
192
206
|
parameters: {};
|
|
193
207
|
}
|
|
@@ -202,6 +216,7 @@ Attachments that have been attached to an object can be viewed by users who can
|
|
|
202
216
|
export interface AttachmentNotFound {
|
|
203
217
|
errorCode: "NOT_FOUND";
|
|
204
218
|
errorName: "AttachmentNotFound";
|
|
219
|
+
errorDescription: "The requested attachment is not found, or the client token does not have access to it. Attachments that are not attached to any objects are deleted after two weeks. Attachments that have not been attached to an object can only be viewed by the user who uploaded them. Attachments that have been attached to an object can be viewed by users who can view the object.";
|
|
205
220
|
errorInstanceId: string;
|
|
206
221
|
parameters: {
|
|
207
222
|
attachmentRid: unknown;
|
|
@@ -216,6 +231,7 @@ The maximum attachment size is 200MB.
|
|
|
216
231
|
export interface AttachmentSizeExceededLimit {
|
|
217
232
|
errorCode: "INVALID_ARGUMENT";
|
|
218
233
|
errorName: "AttachmentSizeExceededLimit";
|
|
234
|
+
errorDescription: "The file is too large to be uploaded as an attachment. The maximum attachment size is 200MB.";
|
|
219
235
|
errorInstanceId: string;
|
|
220
236
|
parameters: {
|
|
221
237
|
fileSizeBytes: unknown;
|
|
@@ -231,6 +247,7 @@ It either does not exist, or you do not have permission to see it.
|
|
|
231
247
|
export interface CipherChannelNotFound {
|
|
232
248
|
errorCode: "NOT_FOUND";
|
|
233
249
|
errorName: "CipherChannelNotFound";
|
|
250
|
+
errorDescription: "The Cipher Channel was not found. It either does not exist, or you do not have permission to see it.";
|
|
234
251
|
errorInstanceId: string;
|
|
235
252
|
parameters: {
|
|
236
253
|
cipherChannel: unknown;
|
|
@@ -245,6 +262,7 @@ please reach out to Palantir Support.
|
|
|
245
262
|
export interface CompositePrimaryKeyNotSupported {
|
|
246
263
|
errorCode: "INVALID_ARGUMENT";
|
|
247
264
|
errorName: "CompositePrimaryKeyNotSupported";
|
|
265
|
+
errorDescription: "Primary keys consisting of multiple properties are not supported by this API. If you need support for this, please reach out to Palantir Support.";
|
|
248
266
|
errorInstanceId: string;
|
|
249
267
|
parameters: {
|
|
250
268
|
objectType: unknown;
|
|
@@ -259,6 +277,7 @@ export interface CompositePrimaryKeyNotSupported {
|
|
|
259
277
|
export interface DefaultAndNullGroupsNotSupported {
|
|
260
278
|
errorCode: "INVALID_ARGUMENT";
|
|
261
279
|
errorName: "DefaultAndNullGroupsNotSupported";
|
|
280
|
+
errorDescription: "Exact match groupBy clause cannot specify a default value and allow null values.";
|
|
262
281
|
errorInstanceId: string;
|
|
263
282
|
parameters: {};
|
|
264
283
|
}
|
|
@@ -270,6 +289,7 @@ export interface DefaultAndNullGroupsNotSupported {
|
|
|
270
289
|
export interface DerivedPropertyApiNamesNotUnique {
|
|
271
290
|
errorCode: "INVALID_ARGUMENT";
|
|
272
291
|
errorName: "DerivedPropertyApiNamesNotUnique";
|
|
292
|
+
errorDescription: "At least one of the requested derived property API names already exist on the object set.";
|
|
273
293
|
errorInstanceId: string;
|
|
274
294
|
parameters: {
|
|
275
295
|
derivedPropertyApiNames: unknown;
|
|
@@ -283,6 +303,7 @@ export interface DerivedPropertyApiNamesNotUnique {
|
|
|
283
303
|
export interface DuplicateOrderBy {
|
|
284
304
|
errorCode: "INVALID_ARGUMENT";
|
|
285
305
|
errorName: "DuplicateOrderBy";
|
|
306
|
+
errorDescription: "The requested sort order includes duplicate properties.";
|
|
286
307
|
errorInstanceId: string;
|
|
287
308
|
parameters: {
|
|
288
309
|
properties: unknown;
|
|
@@ -296,6 +317,7 @@ export interface DuplicateOrderBy {
|
|
|
296
317
|
export interface EditObjectPermissionDenied {
|
|
297
318
|
errorCode: "PERMISSION_DENIED";
|
|
298
319
|
errorName: "EditObjectPermissionDenied";
|
|
320
|
+
errorDescription: "The user does not have permission to edit this ObjectType.";
|
|
299
321
|
errorInstanceId: string;
|
|
300
322
|
parameters: {};
|
|
301
323
|
}
|
|
@@ -308,6 +330,7 @@ is meant to be displayed to the user.
|
|
|
308
330
|
export interface FunctionEncounteredUserFacingError {
|
|
309
331
|
errorCode: "INVALID_ARGUMENT";
|
|
310
332
|
errorName: "FunctionEncounteredUserFacingError";
|
|
333
|
+
errorDescription: "The authored function failed to execute because of a user induced error. The message argument is meant to be displayed to the user.";
|
|
311
334
|
errorInstanceId: string;
|
|
312
335
|
parameters: {
|
|
313
336
|
functionRid: unknown;
|
|
@@ -321,6 +344,7 @@ export interface FunctionEncounteredUserFacingError {
|
|
|
321
344
|
export interface FunctionExecutionFailed {
|
|
322
345
|
errorCode: "INVALID_ARGUMENT";
|
|
323
346
|
errorName: "FunctionExecutionFailed";
|
|
347
|
+
errorDescription: "";
|
|
324
348
|
errorInstanceId: string;
|
|
325
349
|
parameters: {
|
|
326
350
|
functionRid: unknown;
|
|
@@ -335,6 +359,7 @@ export interface FunctionExecutionFailed {
|
|
|
335
359
|
export interface FunctionExecutionTimedOut {
|
|
336
360
|
errorCode: "TIMEOUT";
|
|
337
361
|
errorName: "FunctionExecutionTimedOut";
|
|
362
|
+
errorDescription: "";
|
|
338
363
|
errorInstanceId: string;
|
|
339
364
|
parameters: {
|
|
340
365
|
functionRid: unknown;
|
|
@@ -347,6 +372,7 @@ export interface FunctionExecutionTimedOut {
|
|
|
347
372
|
export interface FunctionInvalidInput {
|
|
348
373
|
errorCode: "INVALID_ARGUMENT";
|
|
349
374
|
errorName: "FunctionInvalidInput";
|
|
375
|
+
errorDescription: "";
|
|
350
376
|
errorInstanceId: string;
|
|
351
377
|
parameters: {
|
|
352
378
|
functionRid: unknown;
|
|
@@ -361,6 +387,7 @@ export interface FunctionInvalidInput {
|
|
|
361
387
|
export interface HighScaleComputationNotEnabled {
|
|
362
388
|
errorCode: "TIMEOUT";
|
|
363
389
|
errorName: "HighScaleComputationNotEnabled";
|
|
390
|
+
errorDescription: "High-scale compute was required for this Ontology query but is not enabled on this enrollment.";
|
|
364
391
|
errorInstanceId: string;
|
|
365
392
|
parameters: {};
|
|
366
393
|
}
|
|
@@ -372,6 +399,7 @@ export interface HighScaleComputationNotEnabled {
|
|
|
372
399
|
export interface InterfaceLinkTypeNotFound {
|
|
373
400
|
errorCode: "NOT_FOUND";
|
|
374
401
|
errorName: "InterfaceLinkTypeNotFound";
|
|
402
|
+
errorDescription: "The requested interface link type is not found, or the client token does not have access to it.";
|
|
375
403
|
errorInstanceId: string;
|
|
376
404
|
parameters: {
|
|
377
405
|
interfaceTypeApiName: unknown;
|
|
@@ -388,6 +416,7 @@ export interface InterfaceLinkTypeNotFound {
|
|
|
388
416
|
export interface InterfaceTypeNotFound {
|
|
389
417
|
errorCode: "NOT_FOUND";
|
|
390
418
|
errorName: "InterfaceTypeNotFound";
|
|
419
|
+
errorDescription: "The requested interface type is not found, or the client token does not have access to it.";
|
|
391
420
|
errorInstanceId: string;
|
|
392
421
|
parameters: {
|
|
393
422
|
apiName: unknown;
|
|
@@ -402,6 +431,7 @@ export interface InterfaceTypeNotFound {
|
|
|
402
431
|
export interface InterfaceTypesNotFound {
|
|
403
432
|
errorCode: "NOT_FOUND";
|
|
404
433
|
errorName: "InterfaceTypesNotFound";
|
|
434
|
+
errorDescription: "The requested interface types were not found, or the client token does not have access to it.";
|
|
405
435
|
errorInstanceId: string;
|
|
406
436
|
parameters: {
|
|
407
437
|
apiName: unknown;
|
|
@@ -416,6 +446,7 @@ export interface InterfaceTypesNotFound {
|
|
|
416
446
|
export interface InvalidAggregationOrdering {
|
|
417
447
|
errorCode: "INVALID_ARGUMENT";
|
|
418
448
|
errorName: "InvalidAggregationOrdering";
|
|
449
|
+
errorDescription: "Aggregation ordering can only be applied to metrics with exactly one groupBy clause.";
|
|
419
450
|
errorInstanceId: string;
|
|
420
451
|
parameters: {};
|
|
421
452
|
}
|
|
@@ -427,6 +458,7 @@ export interface InvalidAggregationOrdering {
|
|
|
427
458
|
export interface InvalidAggregationOrderingWithNullValues {
|
|
428
459
|
errorCode: "INVALID_ARGUMENT";
|
|
429
460
|
errorName: "InvalidAggregationOrderingWithNullValues";
|
|
461
|
+
errorDescription: "Aggregation ordering cannot be applied for groupBy clauses that allow null values.";
|
|
430
462
|
errorInstanceId: string;
|
|
431
463
|
parameters: {};
|
|
432
464
|
}
|
|
@@ -438,6 +470,7 @@ export interface InvalidAggregationOrderingWithNullValues {
|
|
|
438
470
|
export interface InvalidAggregationRange {
|
|
439
471
|
errorCode: "INVALID_ARGUMENT";
|
|
440
472
|
errorName: "InvalidAggregationRange";
|
|
473
|
+
errorDescription: "Aggregation range should include one lt or lte and one gt or gte.";
|
|
441
474
|
errorInstanceId: string;
|
|
442
475
|
parameters: {};
|
|
443
476
|
}
|
|
@@ -449,6 +482,7 @@ export interface InvalidAggregationRange {
|
|
|
449
482
|
export interface InvalidAggregationRangePropertyType {
|
|
450
483
|
errorCode: "INVALID_ARGUMENT";
|
|
451
484
|
errorName: "InvalidAggregationRangePropertyType";
|
|
485
|
+
errorDescription: "Range group by is not supported by property type.";
|
|
452
486
|
errorInstanceId: string;
|
|
453
487
|
parameters: {
|
|
454
488
|
property: unknown;
|
|
@@ -464,6 +498,7 @@ export interface InvalidAggregationRangePropertyType {
|
|
|
464
498
|
export interface InvalidAggregationRangeValue {
|
|
465
499
|
errorCode: "INVALID_ARGUMENT";
|
|
466
500
|
errorName: "InvalidAggregationRangeValue";
|
|
501
|
+
errorDescription: "Aggregation value does not conform to the expected underlying type.";
|
|
467
502
|
errorInstanceId: string;
|
|
468
503
|
parameters: {
|
|
469
504
|
property: unknown;
|
|
@@ -479,6 +514,7 @@ export interface InvalidAggregationRangeValue {
|
|
|
479
514
|
export interface InvalidApplyActionOptionCombination {
|
|
480
515
|
errorCode: "INVALID_ARGUMENT";
|
|
481
516
|
errorName: "InvalidApplyActionOptionCombination";
|
|
517
|
+
errorDescription: "The given options are individually valid but cannot be used in the given combination.";
|
|
482
518
|
errorInstanceId: string;
|
|
483
519
|
parameters: {
|
|
484
520
|
invalidCombination: unknown;
|
|
@@ -492,6 +528,7 @@ export interface InvalidApplyActionOptionCombination {
|
|
|
492
528
|
export interface InvalidContentLength {
|
|
493
529
|
errorCode: "INVALID_ARGUMENT";
|
|
494
530
|
errorName: "InvalidContentLength";
|
|
531
|
+
errorDescription: "A Content-Length header is required for all uploads, but was missing or invalid.";
|
|
495
532
|
errorInstanceId: string;
|
|
496
533
|
parameters: {};
|
|
497
534
|
}
|
|
@@ -504,6 +541,7 @@ Please check your request content and filename to ensure they are compatible.
|
|
|
504
541
|
export interface InvalidContentType {
|
|
505
542
|
errorCode: "INVALID_ARGUMENT";
|
|
506
543
|
errorName: "InvalidContentType";
|
|
544
|
+
errorDescription: "The Content-Type cannot be inferred from the request content and filename. Please check your request content and filename to ensure they are compatible.";
|
|
507
545
|
errorInstanceId: string;
|
|
508
546
|
parameters: {};
|
|
509
547
|
}
|
|
@@ -515,6 +553,7 @@ export interface InvalidContentType {
|
|
|
515
553
|
export interface InvalidDerivedPropertyDefinition {
|
|
516
554
|
errorCode: "INVALID_ARGUMENT";
|
|
517
555
|
errorName: "InvalidDerivedPropertyDefinition";
|
|
556
|
+
errorDescription: "Derived property definition was invalid due to shape of query or type checking.";
|
|
518
557
|
errorInstanceId: string;
|
|
519
558
|
parameters: {
|
|
520
559
|
objectType: unknown;
|
|
@@ -529,6 +568,7 @@ export interface InvalidDerivedPropertyDefinition {
|
|
|
529
568
|
export interface InvalidDurationGroupByPropertyType {
|
|
530
569
|
errorCode: "INVALID_ARGUMENT";
|
|
531
570
|
errorName: "InvalidDurationGroupByPropertyType";
|
|
571
|
+
errorDescription: "Invalid property type for duration groupBy.";
|
|
532
572
|
errorInstanceId: string;
|
|
533
573
|
parameters: {
|
|
534
574
|
property: unknown;
|
|
@@ -546,6 +586,7 @@ every two hours are allowed.
|
|
|
546
586
|
export interface InvalidDurationGroupByValue {
|
|
547
587
|
errorCode: "INVALID_ARGUMENT";
|
|
548
588
|
errorName: "InvalidDurationGroupByValue";
|
|
589
|
+
errorDescription: "Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by every two hours are allowed.";
|
|
549
590
|
errorInstanceId: string;
|
|
550
591
|
parameters: {};
|
|
551
592
|
}
|
|
@@ -558,6 +599,7 @@ should be written properties.id.
|
|
|
558
599
|
export interface InvalidFields {
|
|
559
600
|
errorCode: "INVALID_ARGUMENT";
|
|
560
601
|
errorName: "InvalidFields";
|
|
602
|
+
errorDescription: "The value of the given field does not match the expected pattern. For example, an Ontology object property id should be written properties.id.";
|
|
561
603
|
errorInstanceId: string;
|
|
562
604
|
parameters: {
|
|
563
605
|
properties: unknown;
|
|
@@ -571,6 +613,7 @@ export interface InvalidFields {
|
|
|
571
613
|
export interface InvalidGroupId {
|
|
572
614
|
errorCode: "INVALID_ARGUMENT";
|
|
573
615
|
errorName: "InvalidGroupId";
|
|
616
|
+
errorDescription: "The provided value for a group id must be a UUID.";
|
|
574
617
|
errorInstanceId: string;
|
|
575
618
|
parameters: {
|
|
576
619
|
groupId: unknown;
|
|
@@ -584,6 +627,7 @@ export interface InvalidGroupId {
|
|
|
584
627
|
export interface InvalidOrderType {
|
|
585
628
|
errorCode: "INVALID_ARGUMENT";
|
|
586
629
|
errorName: "InvalidOrderType";
|
|
630
|
+
errorDescription: "This query type does not support the provided order type";
|
|
587
631
|
errorInstanceId: string;
|
|
588
632
|
parameters: {
|
|
589
633
|
orderType: unknown;
|
|
@@ -598,6 +642,7 @@ how parameters are represented.
|
|
|
598
642
|
export interface InvalidParameterValue {
|
|
599
643
|
errorCode: "INVALID_ARGUMENT";
|
|
600
644
|
errorName: "InvalidParameterValue";
|
|
645
|
+
errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented.";
|
|
601
646
|
errorInstanceId: string;
|
|
602
647
|
parameters: {
|
|
603
648
|
parameterBaseType: unknown;
|
|
@@ -614,6 +659,7 @@ export interface InvalidParameterValue {
|
|
|
614
659
|
export interface InvalidPropertyFiltersCombination {
|
|
615
660
|
errorCode: "INVALID_ARGUMENT";
|
|
616
661
|
errorName: "InvalidPropertyFiltersCombination";
|
|
662
|
+
errorDescription: "The provided filters cannot be used together.";
|
|
617
663
|
errorInstanceId: string;
|
|
618
664
|
parameters: {
|
|
619
665
|
propertyFilters: unknown;
|
|
@@ -629,6 +675,7 @@ isNull in properties.address.isNull=2 because the isNull filter expects a value
|
|
|
629
675
|
export interface InvalidPropertyFilterValue {
|
|
630
676
|
errorCode: "INVALID_ARGUMENT";
|
|
631
677
|
errorName: "InvalidPropertyFilterValue";
|
|
678
|
+
errorDescription: "The value of the given property filter is invalid. For instance, 2 is an invalid value for isNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type.";
|
|
632
679
|
errorInstanceId: string;
|
|
633
680
|
parameters: {
|
|
634
681
|
expectedType: unknown;
|
|
@@ -645,6 +692,7 @@ export interface InvalidPropertyFilterValue {
|
|
|
645
692
|
export interface InvalidPropertyType {
|
|
646
693
|
errorCode: "INVALID_ARGUMENT";
|
|
647
694
|
errorName: "InvalidPropertyType";
|
|
695
|
+
errorDescription: "The given property type is not of the expected type.";
|
|
648
696
|
errorInstanceId: string;
|
|
649
697
|
parameters: {
|
|
650
698
|
propertyBaseType: unknown;
|
|
@@ -660,6 +708,7 @@ how properties are represented.
|
|
|
660
708
|
export interface InvalidPropertyValue {
|
|
661
709
|
errorCode: "INVALID_ARGUMENT";
|
|
662
710
|
errorName: "InvalidPropertyValue";
|
|
711
|
+
errorDescription: "The value of the given property is invalid. See the documentation of PropertyValue for details on how properties are represented.";
|
|
663
712
|
errorInstanceId: string;
|
|
664
713
|
parameters: {
|
|
665
714
|
propertyBaseType: unknown;
|
|
@@ -676,6 +725,7 @@ output type or constraints.
|
|
|
676
725
|
export interface InvalidQueryOutputValue {
|
|
677
726
|
errorCode: "INVALID_ARGUMENT";
|
|
678
727
|
errorName: "InvalidQueryOutputValue";
|
|
728
|
+
errorDescription: "The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints.";
|
|
679
729
|
errorInstanceId: string;
|
|
680
730
|
parameters: {
|
|
681
731
|
outputDataType: unknown;
|
|
@@ -693,6 +743,7 @@ how parameters are represented.
|
|
|
693
743
|
export interface InvalidQueryParameterValue {
|
|
694
744
|
errorCode: "INVALID_ARGUMENT";
|
|
695
745
|
errorName: "InvalidQueryParameterValue";
|
|
746
|
+
errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented.";
|
|
696
747
|
errorInstanceId: string;
|
|
697
748
|
parameters: {
|
|
698
749
|
parameterDataType: unknown;
|
|
@@ -708,6 +759,7 @@ export interface InvalidQueryParameterValue {
|
|
|
708
759
|
export interface InvalidRangeQuery {
|
|
709
760
|
errorCode: "INVALID_ARGUMENT";
|
|
710
761
|
errorName: "InvalidRangeQuery";
|
|
762
|
+
errorDescription: "The specified query range filter is invalid.";
|
|
711
763
|
errorInstanceId: string;
|
|
712
764
|
parameters: {
|
|
713
765
|
lt: unknown;
|
|
@@ -726,6 +778,7 @@ order can also be omitted, and defaults to 'asc'.
|
|
|
726
778
|
export interface InvalidSortOrder {
|
|
727
779
|
errorCode: "INVALID_ARGUMENT";
|
|
728
780
|
errorName: "InvalidSortOrder";
|
|
781
|
+
errorDescription: "The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort order can also be omitted, and defaults to 'asc'.";
|
|
729
782
|
errorInstanceId: string;
|
|
730
783
|
parameters: {
|
|
731
784
|
invalidSortOrder: unknown;
|
|
@@ -739,6 +792,7 @@ export interface InvalidSortOrder {
|
|
|
739
792
|
export interface InvalidSortType {
|
|
740
793
|
errorCode: "INVALID_ARGUMENT";
|
|
741
794
|
errorName: "InvalidSortType";
|
|
795
|
+
errorDescription: "The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.";
|
|
742
796
|
errorInstanceId: string;
|
|
743
797
|
parameters: {
|
|
744
798
|
invalidSortType: unknown;
|
|
@@ -752,6 +806,7 @@ export interface InvalidSortType {
|
|
|
752
806
|
export interface InvalidUserId {
|
|
753
807
|
errorCode: "INVALID_ARGUMENT";
|
|
754
808
|
errorName: "InvalidUserId";
|
|
809
|
+
errorDescription: "The provided value for a user id must be a UUID.";
|
|
755
810
|
errorInstanceId: string;
|
|
756
811
|
parameters: {
|
|
757
812
|
userId: unknown;
|
|
@@ -765,6 +820,7 @@ export interface InvalidUserId {
|
|
|
765
820
|
export interface InvalidVectorDimension {
|
|
766
821
|
errorCode: "INVALID_ARGUMENT";
|
|
767
822
|
errorName: "InvalidVectorDimension";
|
|
823
|
+
errorDescription: "The dimensions of the provided vector don't match the dimensions of the embedding model being queried.";
|
|
768
824
|
errorInstanceId: string;
|
|
769
825
|
parameters: {
|
|
770
826
|
expectedSize: unknown;
|
|
@@ -779,6 +835,7 @@ export interface InvalidVectorDimension {
|
|
|
779
835
|
export interface LinkAlreadyExists {
|
|
780
836
|
errorCode: "CONFLICT";
|
|
781
837
|
errorName: "LinkAlreadyExists";
|
|
838
|
+
errorDescription: "The link the user is attempting to create already exists.";
|
|
782
839
|
errorInstanceId: string;
|
|
783
840
|
parameters: {};
|
|
784
841
|
}
|
|
@@ -790,6 +847,7 @@ export interface LinkAlreadyExists {
|
|
|
790
847
|
export interface LinkedObjectNotFound {
|
|
791
848
|
errorCode: "NOT_FOUND";
|
|
792
849
|
errorName: "LinkedObjectNotFound";
|
|
850
|
+
errorDescription: "The linked object with the given primary key is not found, or the user does not have access to it.";
|
|
793
851
|
errorInstanceId: string;
|
|
794
852
|
parameters: {
|
|
795
853
|
linkType: unknown;
|
|
@@ -805,6 +863,7 @@ export interface LinkedObjectNotFound {
|
|
|
805
863
|
export interface LinkTypeNotFound {
|
|
806
864
|
errorCode: "NOT_FOUND";
|
|
807
865
|
errorName: "LinkTypeNotFound";
|
|
866
|
+
errorDescription: "The link type is not found, or the user does not have access to it.";
|
|
808
867
|
errorInstanceId: string;
|
|
809
868
|
parameters: {
|
|
810
869
|
objectType: unknown;
|
|
@@ -820,6 +879,7 @@ export interface LinkTypeNotFound {
|
|
|
820
879
|
export interface MalformedPropertyFilters {
|
|
821
880
|
errorCode: "INVALID_ARGUMENT";
|
|
822
881
|
errorName: "MalformedPropertyFilters";
|
|
882
|
+
errorDescription: "At least one of requested filters are malformed. Please look at the documentation of PropertyFilter.";
|
|
823
883
|
errorInstanceId: string;
|
|
824
884
|
parameters: {
|
|
825
885
|
malformedPropertyFilter: unknown;
|
|
@@ -833,6 +893,7 @@ export interface MalformedPropertyFilters {
|
|
|
833
893
|
export interface MarketplaceActionMappingNotFound {
|
|
834
894
|
errorCode: "NOT_FOUND";
|
|
835
895
|
errorName: "MarketplaceActionMappingNotFound";
|
|
896
|
+
errorDescription: "The given action could not be mapped to a Marketplace installation.";
|
|
836
897
|
errorInstanceId: string;
|
|
837
898
|
parameters: {
|
|
838
899
|
actionType: unknown;
|
|
@@ -848,6 +909,7 @@ export interface MarketplaceActionMappingNotFound {
|
|
|
848
909
|
export interface MarketplaceInstallationNotFound {
|
|
849
910
|
errorCode: "NOT_FOUND";
|
|
850
911
|
errorName: "MarketplaceInstallationNotFound";
|
|
912
|
+
errorDescription: "The given marketplace installation could not be found or the user does not have access to it.";
|
|
851
913
|
errorInstanceId: string;
|
|
852
914
|
parameters: {
|
|
853
915
|
artifactRepository: unknown;
|
|
@@ -862,6 +924,7 @@ export interface MarketplaceInstallationNotFound {
|
|
|
862
924
|
export interface MarketplaceLinkMappingNotFound {
|
|
863
925
|
errorCode: "NOT_FOUND";
|
|
864
926
|
errorName: "MarketplaceLinkMappingNotFound";
|
|
927
|
+
errorDescription: "The given link could not be mapped to a Marketplace installation.";
|
|
865
928
|
errorInstanceId: string;
|
|
866
929
|
parameters: {
|
|
867
930
|
linkType: unknown;
|
|
@@ -877,6 +940,7 @@ export interface MarketplaceLinkMappingNotFound {
|
|
|
877
940
|
export interface MarketplaceObjectMappingNotFound {
|
|
878
941
|
errorCode: "NOT_FOUND";
|
|
879
942
|
errorName: "MarketplaceObjectMappingNotFound";
|
|
943
|
+
errorDescription: "The given object could not be mapped to a Marketplace installation.";
|
|
880
944
|
errorInstanceId: string;
|
|
881
945
|
parameters: {
|
|
882
946
|
objectType: unknown;
|
|
@@ -892,6 +956,7 @@ export interface MarketplaceObjectMappingNotFound {
|
|
|
892
956
|
export interface MarketplaceQueryMappingNotFound {
|
|
893
957
|
errorCode: "NOT_FOUND";
|
|
894
958
|
errorName: "MarketplaceQueryMappingNotFound";
|
|
959
|
+
errorDescription: "The given query could not be mapped to a Marketplace installation.";
|
|
895
960
|
errorInstanceId: string;
|
|
896
961
|
parameters: {
|
|
897
962
|
queryType: unknown;
|
|
@@ -907,6 +972,7 @@ export interface MarketplaceQueryMappingNotFound {
|
|
|
907
972
|
export interface MarketplaceSdkActionMappingNotFound {
|
|
908
973
|
errorCode: "NOT_FOUND";
|
|
909
974
|
errorName: "MarketplaceSdkActionMappingNotFound";
|
|
975
|
+
errorDescription: "The given action could not be mapped to a Marketplace installation.";
|
|
910
976
|
errorInstanceId: string;
|
|
911
977
|
parameters: {
|
|
912
978
|
actionType: unknown;
|
|
@@ -922,6 +988,7 @@ export interface MarketplaceSdkActionMappingNotFound {
|
|
|
922
988
|
export interface MarketplaceSdkInstallationNotFound {
|
|
923
989
|
errorCode: "NOT_FOUND";
|
|
924
990
|
errorName: "MarketplaceSdkInstallationNotFound";
|
|
991
|
+
errorDescription: "The given marketplace installation could not be found or the user does not have access to it.";
|
|
925
992
|
errorInstanceId: string;
|
|
926
993
|
parameters: {
|
|
927
994
|
sdkPackageRid: unknown;
|
|
@@ -936,6 +1003,7 @@ export interface MarketplaceSdkInstallationNotFound {
|
|
|
936
1003
|
export interface MarketplaceSdkLinkMappingNotFound {
|
|
937
1004
|
errorCode: "NOT_FOUND";
|
|
938
1005
|
errorName: "MarketplaceSdkLinkMappingNotFound";
|
|
1006
|
+
errorDescription: "The given link could not be mapped to a Marketplace installation.";
|
|
939
1007
|
errorInstanceId: string;
|
|
940
1008
|
parameters: {
|
|
941
1009
|
linkType: unknown;
|
|
@@ -951,6 +1019,7 @@ export interface MarketplaceSdkLinkMappingNotFound {
|
|
|
951
1019
|
export interface MarketplaceSdkObjectMappingNotFound {
|
|
952
1020
|
errorCode: "NOT_FOUND";
|
|
953
1021
|
errorName: "MarketplaceSdkObjectMappingNotFound";
|
|
1022
|
+
errorDescription: "The given object could not be mapped to a Marketplace installation.";
|
|
954
1023
|
errorInstanceId: string;
|
|
955
1024
|
parameters: {
|
|
956
1025
|
localObjectType: unknown;
|
|
@@ -967,6 +1036,7 @@ export interface MarketplaceSdkObjectMappingNotFound {
|
|
|
967
1036
|
export interface MarketplaceSdkPropertyMappingNotFound {
|
|
968
1037
|
errorCode: "NOT_FOUND";
|
|
969
1038
|
errorName: "MarketplaceSdkPropertyMappingNotFound";
|
|
1039
|
+
errorDescription: "The given property could not be mapped to a Marketplace installation.";
|
|
970
1040
|
errorInstanceId: string;
|
|
971
1041
|
parameters: {
|
|
972
1042
|
propertyType: unknown;
|
|
@@ -983,6 +1053,7 @@ export interface MarketplaceSdkPropertyMappingNotFound {
|
|
|
983
1053
|
export interface MarketplaceSdkQueryMappingNotFound {
|
|
984
1054
|
errorCode: "NOT_FOUND";
|
|
985
1055
|
errorName: "MarketplaceSdkQueryMappingNotFound";
|
|
1056
|
+
errorDescription: "The given query could not be mapped to a Marketplace installation.";
|
|
986
1057
|
errorInstanceId: string;
|
|
987
1058
|
parameters: {
|
|
988
1059
|
queryType: unknown;
|
|
@@ -999,6 +1070,7 @@ missing from the request.
|
|
|
999
1070
|
export interface MissingParameter {
|
|
1000
1071
|
errorCode: "INVALID_ARGUMENT";
|
|
1001
1072
|
errorName: "MissingParameter";
|
|
1073
|
+
errorDescription: "Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request.";
|
|
1002
1074
|
errorInstanceId: string;
|
|
1003
1075
|
parameters: {
|
|
1004
1076
|
parameters: unknown;
|
|
@@ -1012,6 +1084,7 @@ export interface MissingParameter {
|
|
|
1012
1084
|
export interface MultipleGroupByOnFieldNotSupported {
|
|
1013
1085
|
errorCode: "INVALID_ARGUMENT";
|
|
1014
1086
|
errorName: "MultipleGroupByOnFieldNotSupported";
|
|
1087
|
+
errorDescription: "Aggregation cannot group by on the same field multiple times.";
|
|
1015
1088
|
errorInstanceId: string;
|
|
1016
1089
|
parameters: {
|
|
1017
1090
|
duplicateFields: unknown;
|
|
@@ -1026,6 +1099,7 @@ it.
|
|
|
1026
1099
|
export interface MultiplePropertyValuesNotSupported {
|
|
1027
1100
|
errorCode: "INVALID_ARGUMENT";
|
|
1028
1101
|
errorName: "MultiplePropertyValuesNotSupported";
|
|
1102
|
+
errorDescription: "One of the requested property filters does not support multiple values. Please include only a single value for it.";
|
|
1029
1103
|
errorInstanceId: string;
|
|
1030
1104
|
parameters: {
|
|
1031
1105
|
propertyFilter: unknown;
|
|
@@ -1042,6 +1116,7 @@ Ensure it is correctly formatted (CIPHERCIPHER).
|
|
|
1042
1116
|
export interface NotCipherFormatted {
|
|
1043
1117
|
errorCode: "INVALID_ARGUMENT";
|
|
1044
1118
|
errorName: "NotCipherFormatted";
|
|
1119
|
+
errorDescription: "The value intended for decryption with Cipher is not formatted correctly. It may already be a plaintext value and not require decryption. Ensure it is correctly formatted (CIPHERCIPHER).";
|
|
1045
1120
|
errorInstanceId: string;
|
|
1046
1121
|
parameters: {
|
|
1047
1122
|
value: unknown;
|
|
@@ -1055,6 +1130,7 @@ export interface NotCipherFormatted {
|
|
|
1055
1130
|
export interface ObjectAlreadyExists {
|
|
1056
1131
|
errorCode: "CONFLICT";
|
|
1057
1132
|
errorName: "ObjectAlreadyExists";
|
|
1133
|
+
errorDescription: "The object the user is attempting to create already exists.";
|
|
1058
1134
|
errorInstanceId: string;
|
|
1059
1135
|
parameters: {};
|
|
1060
1136
|
}
|
|
@@ -1066,6 +1142,7 @@ export interface ObjectAlreadyExists {
|
|
|
1066
1142
|
export interface ObjectChanged {
|
|
1067
1143
|
errorCode: "CONFLICT";
|
|
1068
1144
|
errorName: "ObjectChanged";
|
|
1145
|
+
errorDescription: "An object used by this Action was changed by someone else while the Action was running.";
|
|
1069
1146
|
errorInstanceId: string;
|
|
1070
1147
|
parameters: {
|
|
1071
1148
|
primaryKey: unknown;
|
|
@@ -1080,6 +1157,7 @@ export interface ObjectChanged {
|
|
|
1080
1157
|
export interface ObjectNotFound {
|
|
1081
1158
|
errorCode: "NOT_FOUND";
|
|
1082
1159
|
errorName: "ObjectNotFound";
|
|
1160
|
+
errorDescription: "The requested object is not found, or the client token does not have access to it.";
|
|
1083
1161
|
errorInstanceId: string;
|
|
1084
1162
|
parameters: {
|
|
1085
1163
|
objectType: unknown;
|
|
@@ -1094,6 +1172,7 @@ export interface ObjectNotFound {
|
|
|
1094
1172
|
export interface ObjectSetNotFound {
|
|
1095
1173
|
errorCode: "NOT_FOUND";
|
|
1096
1174
|
errorName: "ObjectSetNotFound";
|
|
1175
|
+
errorDescription: "The requested object set is not found, or the client token does not have access to it.";
|
|
1097
1176
|
errorInstanceId: string;
|
|
1098
1177
|
parameters: {
|
|
1099
1178
|
objectSetRid: unknown;
|
|
@@ -1108,6 +1187,7 @@ API for a given request.
|
|
|
1108
1187
|
export interface ObjectsExceededLimit {
|
|
1109
1188
|
errorCode: "INVALID_ARGUMENT";
|
|
1110
1189
|
errorName: "ObjectsExceededLimit";
|
|
1190
|
+
errorDescription: "There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this API for a given request.";
|
|
1111
1191
|
errorInstanceId: string;
|
|
1112
1192
|
parameters: {};
|
|
1113
1193
|
}
|
|
@@ -1119,6 +1199,7 @@ export interface ObjectsExceededLimit {
|
|
|
1119
1199
|
export interface ObjectTypeNotFound {
|
|
1120
1200
|
errorCode: "NOT_FOUND";
|
|
1121
1201
|
errorName: "ObjectTypeNotFound";
|
|
1202
|
+
errorDescription: "The requested object type is not found, or the client token does not have access to it.";
|
|
1122
1203
|
errorInstanceId: string;
|
|
1123
1204
|
parameters: {
|
|
1124
1205
|
objectType: unknown;
|
|
@@ -1134,6 +1215,7 @@ Administrator to re-index the object type in Ontology Management Application.
|
|
|
1134
1215
|
export interface ObjectTypeNotSynced {
|
|
1135
1216
|
errorCode: "CONFLICT";
|
|
1136
1217
|
errorName: "ObjectTypeNotSynced";
|
|
1218
|
+
errorDescription: "The requested object type is not synced into the ontology. Please reach out to your Ontology Administrator to re-index the object type in Ontology Management Application.";
|
|
1137
1219
|
errorInstanceId: string;
|
|
1138
1220
|
parameters: {
|
|
1139
1221
|
objectType: unknown;
|
|
@@ -1148,6 +1230,7 @@ Administrator to re-index the object type(s) in Ontology Management Application.
|
|
|
1148
1230
|
export interface ObjectTypesNotSynced {
|
|
1149
1231
|
errorCode: "CONFLICT";
|
|
1150
1232
|
errorName: "ObjectTypesNotSynced";
|
|
1233
|
+
errorDescription: "One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology Administrator to re-index the object type(s) in Ontology Management Application.";
|
|
1151
1234
|
errorInstanceId: string;
|
|
1152
1235
|
parameters: {
|
|
1153
1236
|
objectTypes: unknown;
|
|
@@ -1161,6 +1244,7 @@ export interface ObjectTypesNotSynced {
|
|
|
1161
1244
|
export interface OntologyApiNameNotUnique {
|
|
1162
1245
|
errorCode: "INVALID_ARGUMENT";
|
|
1163
1246
|
errorName: "OntologyApiNameNotUnique";
|
|
1247
|
+
errorDescription: "The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.";
|
|
1164
1248
|
errorInstanceId: string;
|
|
1165
1249
|
parameters: {
|
|
1166
1250
|
ontologyApiName: unknown;
|
|
@@ -1176,6 +1260,7 @@ Please change the size of your request or contact the Ontology administrator.
|
|
|
1176
1260
|
export interface OntologyEditsExceededLimit {
|
|
1177
1261
|
errorCode: "INVALID_ARGUMENT";
|
|
1178
1262
|
errorName: "OntologyEditsExceededLimit";
|
|
1263
|
+
errorDescription: "The number of edits to the Ontology exceeded the allowed limit. This may happen because of the request or because the Action is modifying too many objects. Please change the size of your request or contact the Ontology administrator.";
|
|
1179
1264
|
errorInstanceId: string;
|
|
1180
1265
|
parameters: {
|
|
1181
1266
|
editsCount: unknown;
|
|
@@ -1190,6 +1275,7 @@ export interface OntologyEditsExceededLimit {
|
|
|
1190
1275
|
export interface OntologyNotFound {
|
|
1191
1276
|
errorCode: "NOT_FOUND";
|
|
1192
1277
|
errorName: "OntologyNotFound";
|
|
1278
|
+
errorDescription: "The requested Ontology is not found, or the client token does not have access to it.";
|
|
1193
1279
|
errorInstanceId: string;
|
|
1194
1280
|
parameters: {
|
|
1195
1281
|
ontologyRid: unknown;
|
|
@@ -1205,6 +1291,7 @@ few seconds and try again.
|
|
|
1205
1291
|
export interface OntologySyncing {
|
|
1206
1292
|
errorCode: "CONFLICT";
|
|
1207
1293
|
errorName: "OntologySyncing";
|
|
1294
|
+
errorDescription: "The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a few seconds and try again.";
|
|
1208
1295
|
errorInstanceId: string;
|
|
1209
1296
|
parameters: {
|
|
1210
1297
|
objectType: unknown;
|
|
@@ -1219,6 +1306,7 @@ applied. Wait a few seconds and try again.
|
|
|
1219
1306
|
export interface OntologySyncingObjectTypes {
|
|
1220
1307
|
errorCode: "CONFLICT";
|
|
1221
1308
|
errorName: "OntologySyncingObjectTypes";
|
|
1309
|
+
errorDescription: "One or more requested object types have been changed in the Ontology Manager and changes are currently being applied. Wait a few seconds and try again.";
|
|
1222
1310
|
errorInstanceId: string;
|
|
1223
1311
|
parameters: {
|
|
1224
1312
|
objectTypes: unknown;
|
|
@@ -1232,6 +1320,7 @@ export interface OntologySyncingObjectTypes {
|
|
|
1232
1320
|
export interface ParameterObjectNotFound {
|
|
1233
1321
|
errorCode: "NOT_FOUND";
|
|
1234
1322
|
errorName: "ParameterObjectNotFound";
|
|
1323
|
+
errorDescription: "The parameter object reference or parameter default value is not found, or the client token does not have access to it.";
|
|
1235
1324
|
errorInstanceId: string;
|
|
1236
1325
|
parameters: {
|
|
1237
1326
|
objectType: unknown;
|
|
@@ -1246,6 +1335,7 @@ export interface ParameterObjectNotFound {
|
|
|
1246
1335
|
export interface ParameterObjectSetRidNotFound {
|
|
1247
1336
|
errorCode: "NOT_FOUND";
|
|
1248
1337
|
errorName: "ParameterObjectSetRidNotFound";
|
|
1338
|
+
errorDescription: "The parameter object set RID is not found, or the client token does not have access to it.";
|
|
1249
1339
|
errorInstanceId: string;
|
|
1250
1340
|
parameters: {
|
|
1251
1341
|
objectSetRid: unknown;
|
|
@@ -1260,6 +1350,7 @@ to see which ones are available.
|
|
|
1260
1350
|
export interface ParametersNotFound {
|
|
1261
1351
|
errorCode: "INVALID_ARGUMENT";
|
|
1262
1352
|
errorName: "ParametersNotFound";
|
|
1353
|
+
errorDescription: "The provided parameter ID was not found for the action. Please look at the configuredParameterIds field to see which ones are available.";
|
|
1263
1354
|
errorInstanceId: string;
|
|
1264
1355
|
parameters: {
|
|
1265
1356
|
actionType: unknown;
|
|
@@ -1276,6 +1367,7 @@ please reach out to Palantir Support.
|
|
|
1276
1367
|
export interface ParameterTypeNotSupported {
|
|
1277
1368
|
errorCode: "INVALID_ARGUMENT";
|
|
1278
1369
|
errorName: "ParameterTypeNotSupported";
|
|
1370
|
+
errorDescription: "The type of the requested parameter is not currently supported by this API. If you need support for this, please reach out to Palantir Support.";
|
|
1279
1371
|
errorInstanceId: string;
|
|
1280
1372
|
parameters: {
|
|
1281
1373
|
parameterId: unknown;
|
|
@@ -1290,6 +1382,7 @@ export interface ParameterTypeNotSupported {
|
|
|
1290
1382
|
export interface ParentAttachmentPermissionDenied {
|
|
1291
1383
|
errorCode: "PERMISSION_DENIED";
|
|
1292
1384
|
errorName: "ParentAttachmentPermissionDenied";
|
|
1385
|
+
errorDescription: "The user does not have permission to parent attachments.";
|
|
1293
1386
|
errorInstanceId: string;
|
|
1294
1387
|
parameters: {};
|
|
1295
1388
|
}
|
|
@@ -1301,6 +1394,7 @@ export interface ParentAttachmentPermissionDenied {
|
|
|
1301
1394
|
export interface PropertiesHaveDifferentIds {
|
|
1302
1395
|
errorCode: "INVALID_ARGUMENT";
|
|
1303
1396
|
errorName: "PropertiesHaveDifferentIds";
|
|
1397
|
+
errorDescription: "Properties used in ordering must have the same ids. Temporary restriction imposed due to OSS limitations.";
|
|
1304
1398
|
errorInstanceId: string;
|
|
1305
1399
|
parameters: {
|
|
1306
1400
|
properties: unknown;
|
|
@@ -1316,6 +1410,7 @@ between the time a property is marked Searchable and Selectable and when it can
|
|
|
1316
1410
|
export interface PropertiesNotFilterable {
|
|
1317
1411
|
errorCode: "INVALID_ARGUMENT";
|
|
1318
1412
|
errorName: "PropertiesNotFilterable";
|
|
1413
|
+
errorDescription: "Results could not be filtered by the requested properties. Please mark the properties as Searchable and Selectable in the Ontology Manager to be able to filter on those properties. There may be a short delay between the time a property is marked Searchable and Selectable and when it can be used.";
|
|
1319
1414
|
errorInstanceId: string;
|
|
1320
1415
|
parameters: {
|
|
1321
1416
|
properties: unknown;
|
|
@@ -1329,6 +1424,7 @@ export interface PropertiesNotFilterable {
|
|
|
1329
1424
|
export interface PropertiesNotFound {
|
|
1330
1425
|
errorCode: "NOT_FOUND";
|
|
1331
1426
|
errorName: "PropertiesNotFound";
|
|
1427
|
+
errorDescription: "The requested properties are not found on the object type.";
|
|
1332
1428
|
errorInstanceId: string;
|
|
1333
1429
|
parameters: {
|
|
1334
1430
|
objectType: unknown;
|
|
@@ -1345,6 +1441,7 @@ between the time a property is marked Searchable and when it can be used.
|
|
|
1345
1441
|
export interface PropertiesNotSearchable {
|
|
1346
1442
|
errorCode: "INVALID_ARGUMENT";
|
|
1347
1443
|
errorName: "PropertiesNotSearchable";
|
|
1444
|
+
errorDescription: "Search is not enabled on the specified properties. Please mark the properties as Searchable in the Ontology Manager to enable search on them. There may be a short delay between the time a property is marked Searchable and when it can be used.";
|
|
1348
1445
|
errorInstanceId: string;
|
|
1349
1446
|
parameters: {
|
|
1350
1447
|
propertyApiNames: unknown;
|
|
@@ -1360,6 +1457,7 @@ between the time a property is set to Searchable and Sortable and when it can be
|
|
|
1360
1457
|
export interface PropertiesNotSortable {
|
|
1361
1458
|
errorCode: "INVALID_ARGUMENT";
|
|
1362
1459
|
errorName: "PropertiesNotSortable";
|
|
1460
|
+
errorDescription: "Results could not be ordered by the requested properties. Please mark the properties as Searchable and Sortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay between the time a property is set to Searchable and Sortable and when it can be used.";
|
|
1363
1461
|
errorInstanceId: string;
|
|
1364
1462
|
parameters: {
|
|
1365
1463
|
properties: unknown;
|
|
@@ -1374,6 +1472,7 @@ name for it using the Ontology Manager.
|
|
|
1374
1472
|
export interface PropertyApiNameNotFound {
|
|
1375
1473
|
errorCode: "INVALID_ARGUMENT";
|
|
1376
1474
|
errorName: "PropertyApiNameNotFound";
|
|
1475
|
+
errorDescription: "A property that was required to have an API name, such as a primary key, is missing one. You can set an API name for it using the Ontology Manager.";
|
|
1377
1476
|
errorInstanceId: string;
|
|
1378
1477
|
parameters: {
|
|
1379
1478
|
propertyId: unknown;
|
|
@@ -1389,6 +1488,7 @@ please reach out to Palantir Support.
|
|
|
1389
1488
|
export interface PropertyBaseTypeNotSupported {
|
|
1390
1489
|
errorCode: "INVALID_ARGUMENT";
|
|
1391
1490
|
errorName: "PropertyBaseTypeNotSupported";
|
|
1491
|
+
errorDescription: "The type of the requested property is not currently supported by this API. If you need support for this, please reach out to Palantir Support.";
|
|
1392
1492
|
errorInstanceId: string;
|
|
1393
1493
|
parameters: {
|
|
1394
1494
|
objectType: unknown;
|
|
@@ -1404,6 +1504,7 @@ export interface PropertyBaseTypeNotSupported {
|
|
|
1404
1504
|
export interface PropertyExactMatchingNotSupported {
|
|
1405
1505
|
errorCode: "INVALID_ARGUMENT";
|
|
1406
1506
|
errorName: "PropertyExactMatchingNotSupported";
|
|
1507
|
+
errorDescription: "A property that does not support exact matching is used in a setting that requires exact matching.";
|
|
1407
1508
|
errorInstanceId: string;
|
|
1408
1509
|
parameters: {
|
|
1409
1510
|
propertyBaseType: unknown;
|
|
@@ -1419,6 +1520,7 @@ a list of supported property filters.
|
|
|
1419
1520
|
export interface PropertyFiltersNotSupported {
|
|
1420
1521
|
errorCode: "INVALID_ARGUMENT";
|
|
1421
1522
|
errorName: "PropertyFiltersNotSupported";
|
|
1523
|
+
errorDescription: "At least one of the requested property filters are not supported. See the documentation of PropertyFilter for a list of supported property filters.";
|
|
1422
1524
|
errorInstanceId: string;
|
|
1423
1525
|
parameters: {
|
|
1424
1526
|
propertyFilters: unknown;
|
|
@@ -1433,6 +1535,7 @@ export interface PropertyFiltersNotSupported {
|
|
|
1433
1535
|
export interface PropertyNotFound {
|
|
1434
1536
|
errorCode: "INVALID_ARGUMENT";
|
|
1435
1537
|
errorName: "PropertyNotFound";
|
|
1538
|
+
errorDescription: "Failed to find a provided property for a given object.";
|
|
1436
1539
|
errorInstanceId: string;
|
|
1437
1540
|
parameters: {};
|
|
1438
1541
|
}
|
|
@@ -1444,6 +1547,7 @@ export interface PropertyNotFound {
|
|
|
1444
1547
|
export interface PropertyNotFoundOnObject {
|
|
1445
1548
|
errorCode: "INVALID_ARGUMENT";
|
|
1446
1549
|
errorName: "PropertyNotFoundOnObject";
|
|
1550
|
+
errorDescription: "Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.";
|
|
1447
1551
|
errorInstanceId: string;
|
|
1448
1552
|
parameters: {
|
|
1449
1553
|
objectTypeRid: unknown;
|
|
@@ -1459,6 +1563,7 @@ export interface PropertyNotFoundOnObject {
|
|
|
1459
1563
|
export interface PropertyTypeDoesNotSupportNearestNeighbors {
|
|
1460
1564
|
errorCode: "INVALID_ARGUMENT";
|
|
1461
1565
|
errorName: "PropertyTypeDoesNotSupportNearestNeighbors";
|
|
1566
|
+
errorDescription: "The provided propertyIdentifier is not configured with an embedding model in the ontology.";
|
|
1462
1567
|
errorInstanceId: string;
|
|
1463
1568
|
parameters: {};
|
|
1464
1569
|
}
|
|
@@ -1470,6 +1575,7 @@ export interface PropertyTypeDoesNotSupportNearestNeighbors {
|
|
|
1470
1575
|
export interface PropertyTypeNotFound {
|
|
1471
1576
|
errorCode: "NOT_FOUND";
|
|
1472
1577
|
errorName: "PropertyTypeNotFound";
|
|
1578
|
+
errorDescription: "The requested property type is not found, or the client token does not have access to it.";
|
|
1473
1579
|
errorInstanceId: string;
|
|
1474
1580
|
parameters: {
|
|
1475
1581
|
objectTypeApiName: unknown;
|
|
@@ -1484,6 +1590,7 @@ export interface PropertyTypeNotFound {
|
|
|
1484
1590
|
export interface PropertyTypeRidNotFound {
|
|
1485
1591
|
errorCode: "NOT_FOUND";
|
|
1486
1592
|
errorName: "PropertyTypeRidNotFound";
|
|
1593
|
+
errorDescription: "The requested property type RID is not found, or the client token does not have access to it.";
|
|
1487
1594
|
errorInstanceId: string;
|
|
1488
1595
|
parameters: {
|
|
1489
1596
|
propertyTypeRid: unknown;
|
|
@@ -1498,6 +1605,7 @@ a list of supported search queries on different property types.
|
|
|
1498
1605
|
export interface PropertyTypesSearchNotSupported {
|
|
1499
1606
|
errorCode: "INVALID_ARGUMENT";
|
|
1500
1607
|
errorName: "PropertyTypesSearchNotSupported";
|
|
1608
|
+
errorDescription: "The search on the property types are not supported. See the Search Objects documentation for a list of supported search queries on different property types.";
|
|
1501
1609
|
errorInstanceId: string;
|
|
1502
1610
|
parameters: {
|
|
1503
1611
|
parameters: unknown;
|
|
@@ -1512,6 +1620,7 @@ is meant to be displayed to the user.
|
|
|
1512
1620
|
export interface QueryEncounteredUserFacingError {
|
|
1513
1621
|
errorCode: "CONFLICT";
|
|
1514
1622
|
errorName: "QueryEncounteredUserFacingError";
|
|
1623
|
+
errorDescription: "The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user.";
|
|
1515
1624
|
errorInstanceId: string;
|
|
1516
1625
|
parameters: {
|
|
1517
1626
|
functionRid: unknown;
|
|
@@ -1527,6 +1636,7 @@ export interface QueryEncounteredUserFacingError {
|
|
|
1527
1636
|
export interface QueryMemoryExceededLimit {
|
|
1528
1637
|
errorCode: "TIMEOUT";
|
|
1529
1638
|
errorName: "QueryMemoryExceededLimit";
|
|
1639
|
+
errorDescription: "Memory limits were exceeded for the Query execution.";
|
|
1530
1640
|
errorInstanceId: string;
|
|
1531
1641
|
parameters: {
|
|
1532
1642
|
functionRid: unknown;
|
|
@@ -1541,6 +1651,7 @@ export interface QueryMemoryExceededLimit {
|
|
|
1541
1651
|
export interface QueryNotFound {
|
|
1542
1652
|
errorCode: "NOT_FOUND";
|
|
1543
1653
|
errorName: "QueryNotFound";
|
|
1654
|
+
errorDescription: "The query is not found, or the user does not have access to it.";
|
|
1544
1655
|
errorInstanceId: string;
|
|
1545
1656
|
parameters: {
|
|
1546
1657
|
query: unknown;
|
|
@@ -1554,6 +1665,7 @@ export interface QueryNotFound {
|
|
|
1554
1665
|
export interface QueryRuntimeError {
|
|
1555
1666
|
errorCode: "INVALID_ARGUMENT";
|
|
1556
1667
|
errorName: "QueryRuntimeError";
|
|
1668
|
+
errorDescription: "The authored Query failed to execute because of a runtime error.";
|
|
1557
1669
|
errorInstanceId: string;
|
|
1558
1670
|
parameters: {
|
|
1559
1671
|
functionRid: unknown;
|
|
@@ -1571,6 +1683,7 @@ export interface QueryRuntimeError {
|
|
|
1571
1683
|
export interface QueryTimeExceededLimit {
|
|
1572
1684
|
errorCode: "TIMEOUT";
|
|
1573
1685
|
errorName: "QueryTimeExceededLimit";
|
|
1686
|
+
errorDescription: "Time limits were exceeded for the Query execution.";
|
|
1574
1687
|
errorInstanceId: string;
|
|
1575
1688
|
parameters: {
|
|
1576
1689
|
functionRid: unknown;
|
|
@@ -1585,6 +1698,7 @@ export interface QueryTimeExceededLimit {
|
|
|
1585
1698
|
export interface QueryVersionNotFound {
|
|
1586
1699
|
errorCode: "NOT_FOUND";
|
|
1587
1700
|
errorName: "QueryVersionNotFound";
|
|
1701
|
+
errorDescription: "The query could not be found at the provided version.";
|
|
1588
1702
|
errorInstanceId: string;
|
|
1589
1703
|
parameters: {
|
|
1590
1704
|
apiName: unknown;
|
|
@@ -1599,6 +1713,7 @@ export interface QueryVersionNotFound {
|
|
|
1599
1713
|
export interface RateLimitReached {
|
|
1600
1714
|
errorCode: "PERMISSION_DENIED";
|
|
1601
1715
|
errorName: "RateLimitReached";
|
|
1716
|
+
errorDescription: "Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.";
|
|
1602
1717
|
errorInstanceId: string;
|
|
1603
1718
|
parameters: {
|
|
1604
1719
|
cipherChannel: unknown;
|
|
@@ -1612,6 +1727,7 @@ export interface RateLimitReached {
|
|
|
1612
1727
|
export interface SharedPropertiesNotFound {
|
|
1613
1728
|
errorCode: "NOT_FOUND";
|
|
1614
1729
|
errorName: "SharedPropertiesNotFound";
|
|
1730
|
+
errorDescription: "The requested shared property types are not present on every object type.";
|
|
1615
1731
|
errorInstanceId: string;
|
|
1616
1732
|
parameters: {
|
|
1617
1733
|
objectType: unknown;
|
|
@@ -1626,6 +1742,7 @@ export interface SharedPropertiesNotFound {
|
|
|
1626
1742
|
export interface SharedPropertyTypeNotFound {
|
|
1627
1743
|
errorCode: "NOT_FOUND";
|
|
1628
1744
|
errorName: "SharedPropertyTypeNotFound";
|
|
1745
|
+
errorDescription: "The requested shared property type is not found, or the client token does not have access to it.";
|
|
1629
1746
|
errorInstanceId: string;
|
|
1630
1747
|
parameters: {
|
|
1631
1748
|
apiName: unknown;
|
|
@@ -1640,6 +1757,7 @@ export interface SharedPropertyTypeNotFound {
|
|
|
1640
1757
|
export interface TooManyNearestNeighborsRequested {
|
|
1641
1758
|
errorCode: "INVALID_ARGUMENT";
|
|
1642
1759
|
errorName: "TooManyNearestNeighborsRequested";
|
|
1760
|
+
errorDescription: "The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.";
|
|
1643
1761
|
errorInstanceId: string;
|
|
1644
1762
|
parameters: {
|
|
1645
1763
|
requestedNumNeighbors: unknown;
|
|
@@ -1654,6 +1772,7 @@ export interface TooManyNearestNeighborsRequested {
|
|
|
1654
1772
|
export interface UnauthorizedCipherOperation {
|
|
1655
1773
|
errorCode: "PERMISSION_DENIED";
|
|
1656
1774
|
errorName: "UnauthorizedCipherOperation";
|
|
1775
|
+
errorDescription: "The provided token does not have permission to take a specific Cipher operation.";
|
|
1657
1776
|
errorInstanceId: string;
|
|
1658
1777
|
parameters: {
|
|
1659
1778
|
cipherChannel: unknown;
|
|
@@ -1668,6 +1787,7 @@ Ensure it is correctly formatted (CIPHER::CIPHER).
|
|
|
1668
1787
|
export interface UndecryptableValue {
|
|
1669
1788
|
errorCode: "INVALID_ARGUMENT";
|
|
1670
1789
|
errorName: "UndecryptableValue";
|
|
1790
|
+
errorDescription: "The value intended for decryption with Cipher cannot be decrypted. Ensure it is correctly formatted (CIPHER::CIPHER).";
|
|
1671
1791
|
errorInstanceId: string;
|
|
1672
1792
|
parameters: {
|
|
1673
1793
|
value: unknown;
|
|
@@ -1682,6 +1802,7 @@ to see which ones are available.
|
|
|
1682
1802
|
export interface UnknownParameter {
|
|
1683
1803
|
errorCode: "INVALID_ARGUMENT";
|
|
1684
1804
|
errorName: "UnknownParameter";
|
|
1805
|
+
errorDescription: "The provided parameters were not found. Please look at the knownParameters field to see which ones are available.";
|
|
1685
1806
|
errorInstanceId: string;
|
|
1686
1807
|
parameters: {
|
|
1687
1808
|
unknownParameters: unknown;
|
|
@@ -1696,6 +1817,7 @@ export interface UnknownParameter {
|
|
|
1696
1817
|
export interface UnsupportedObjectSet {
|
|
1697
1818
|
errorCode: "INVALID_ARGUMENT";
|
|
1698
1819
|
errorName: "UnsupportedObjectSet";
|
|
1820
|
+
errorDescription: "The requested object set is not supported.";
|
|
1699
1821
|
errorInstanceId: string;
|
|
1700
1822
|
parameters: {};
|
|
1701
1823
|
}
|
|
@@ -1707,6 +1829,7 @@ export interface UnsupportedObjectSet {
|
|
|
1707
1829
|
export interface ValueTypeNotFound {
|
|
1708
1830
|
errorCode: "NOT_FOUND";
|
|
1709
1831
|
errorName: "ValueTypeNotFound";
|
|
1832
|
+
errorDescription: "The value type is not found, or the user does not have access to it.";
|
|
1710
1833
|
errorInstanceId: string;
|
|
1711
1834
|
parameters: {
|
|
1712
1835
|
valueType: unknown;
|
|
@@ -1722,6 +1845,7 @@ type has backing data sources configured and visible.
|
|
|
1722
1845
|
export interface ViewObjectPermissionDenied {
|
|
1723
1846
|
errorCode: "PERMISSION_DENIED";
|
|
1724
1847
|
errorName: "ViewObjectPermissionDenied";
|
|
1848
|
+
errorDescription: "The provided token does not have permission to view any data sources backing this object type. Ensure the object type has backing data sources configured and visible.";
|
|
1725
1849
|
errorInstanceId: string;
|
|
1726
1850
|
parameters: {
|
|
1727
1851
|
objectType: unknown;
|