@osdk/foundry.ontologies 2.52.0 → 2.54.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 +24 -0
- package/build/browser/_components.d.ts +130 -70
- package/build/browser/_components.d.ts.map +1 -1
- package/build/browser/index.d.ts +1 -1
- package/build/browser/index.d.ts.map +1 -1
- package/build/browser/public/ObjectTypeV2.d.ts +20 -0
- package/build/browser/public/ObjectTypeV2.d.ts.map +1 -1
- package/build/browser/public/ObjectTypeV2.js +17 -0
- package/build/browser/public/ObjectTypeV2.js.map +1 -1
- package/build/esm/_components.d.ts +130 -70
- package/build/esm/_components.d.ts.map +1 -1
- package/build/esm/index.d.ts +1 -1
- package/build/esm/index.d.ts.map +1 -1
- package/build/esm/public/ObjectTypeV2.d.ts +20 -0
- package/build/esm/public/ObjectTypeV2.d.ts.map +1 -1
- package/build/esm/public/ObjectTypeV2.js +17 -0
- package/build/esm/public/ObjectTypeV2.js.map +1 -1
- package/package.json +4 -4
|
@@ -43,6 +43,23 @@ const _get = [0, "/v2/ontologies/{0}/objectTypes/{1}", 2];
|
|
|
43
43
|
export function get($ctx, ...args) {
|
|
44
44
|
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
45
45
|
}
|
|
46
|
+
const _getByRidBatch = [1, "/v2/ontologies/{0}/objectTypes/getByRidBatch", 3];
|
|
47
|
+
/**
|
|
48
|
+
* Gets a list of object types by RID in bulk.
|
|
49
|
+
*
|
|
50
|
+
* Object types are filtered from the response if they don't exist or the requesting token lacks the required
|
|
51
|
+
* permissions.
|
|
52
|
+
*
|
|
53
|
+
* The maximum batch size for this endpoint is 100.
|
|
54
|
+
*
|
|
55
|
+
* @beta
|
|
56
|
+
*
|
|
57
|
+
* Required Scopes: [api:ontologies-read]
|
|
58
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/getByRidBatch
|
|
59
|
+
*/
|
|
60
|
+
export function getByRidBatch($ctx, ...args) {
|
|
61
|
+
return $foundryPlatformFetch($ctx, _getByRidBatch, ...args);
|
|
62
|
+
}
|
|
46
63
|
const _getFullMetadata = [0, "/v2/ontologies/{0}/objectTypes/{1}/fullMetadata", 2];
|
|
47
64
|
/**
|
|
48
65
|
* Gets the full metadata for a specific object type with the given API name.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ObjectTypeV2.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_list","list","$ctx","args","_get","get","_getFullMetadata","getFullMetadata","_getEditsHistory","getEditsHistory","_listOutgoingLinkTypes","listOutgoingLinkTypes","_getOutgoingLinkType","getOutgoingLinkType"],"sources":["ObjectTypeV2.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _list = [0, \"/v2/ontologies/{0}/objectTypes\", 2];\n/**\n * Lists the object types for the given Ontology.\n *\n * Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\n * more results available, at least one result will be present in the\n * response.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes\n */\nexport function list($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _list, ...args);\n}\nconst _get = [0, \"/v2/ontologies/{0}/objectTypes/{1}\", 2];\n/**\n * Gets a specific object type with the given API name.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _getFullMetadata = [0, \"/v2/ontologies/{0}/objectTypes/{1}/fullMetadata\", 2];\n/**\n * Gets the full metadata for a specific object type with the given API name.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata\n */\nexport function getFullMetadata($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getFullMetadata, ...args);\n}\nconst _getEditsHistory = [1, \"/v2/ontologies/{0}/objectTypes/{1}/editsHistory\", 3];\n/**\n * Returns the history of edits (additions, modifications, deletions) for objects of a\n * specific object type. This endpoint provides visibility into all actions that have\n * modified objects of this type.\n *\n * The edits are returned in reverse chronological order (most recent first) by default.\n *\n * Note that filters are ignored for OSv1 object types.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory\n */\nexport function getEditsHistory($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getEditsHistory, ...args);\n}\nconst _listOutgoingLinkTypes = [0, \"/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes\", 2];\n/**\n * List the outgoing links for an object type.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes\n */\nexport function listOutgoingLinkTypes($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _listOutgoingLinkTypes, ...args);\n}\nconst _getOutgoingLinkType = [0, \"/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes/{2}\", 2];\n/**\n * Get an outgoing link for an object type.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}\n */\nexport function getOutgoingLinkType($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getOutgoingLinkType, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,KAAK,GAAG,CAAC,CAAC,EAAE,gCAAgC,EAAE,CAAC,CAAC;AACtD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,KAAK,EAAE,GAAGG,IAAI,CAAC;AACtD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,oCAAoC,EAAE,CAAC,CAAC;AACzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,gBAAgB,GAAG,CAAC,CAAC,EAAE,iDAAiD,EAAE,CAAC,CAAC;AAClF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,
|
|
1
|
+
{"version":3,"file":"ObjectTypeV2.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_list","list","$ctx","args","_get","get","_getByRidBatch","getByRidBatch","_getFullMetadata","getFullMetadata","_getEditsHistory","getEditsHistory","_listOutgoingLinkTypes","listOutgoingLinkTypes","_getOutgoingLinkType","getOutgoingLinkType"],"sources":["ObjectTypeV2.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _list = [0, \"/v2/ontologies/{0}/objectTypes\", 2];\n/**\n * Lists the object types for the given Ontology.\n *\n * Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\n * more results available, at least one result will be present in the\n * response.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes\n */\nexport function list($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _list, ...args);\n}\nconst _get = [0, \"/v2/ontologies/{0}/objectTypes/{1}\", 2];\n/**\n * Gets a specific object type with the given API name.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _getByRidBatch = [1, \"/v2/ontologies/{0}/objectTypes/getByRidBatch\", 3];\n/**\n * Gets a list of object types by RID in bulk.\n *\n * Object types are filtered from the response if they don't exist or the requesting token lacks the required\n * permissions.\n *\n * The maximum batch size for this endpoint is 100.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/getByRidBatch\n */\nexport function getByRidBatch($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getByRidBatch, ...args);\n}\nconst _getFullMetadata = [0, \"/v2/ontologies/{0}/objectTypes/{1}/fullMetadata\", 2];\n/**\n * Gets the full metadata for a specific object type with the given API name.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata\n */\nexport function getFullMetadata($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getFullMetadata, ...args);\n}\nconst _getEditsHistory = [1, \"/v2/ontologies/{0}/objectTypes/{1}/editsHistory\", 3];\n/**\n * Returns the history of edits (additions, modifications, deletions) for objects of a\n * specific object type. This endpoint provides visibility into all actions that have\n * modified objects of this type.\n *\n * The edits are returned in reverse chronological order (most recent first) by default.\n *\n * Note that filters are ignored for OSv1 object types.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory\n */\nexport function getEditsHistory($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getEditsHistory, ...args);\n}\nconst _listOutgoingLinkTypes = [0, \"/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes\", 2];\n/**\n * List the outgoing links for an object type.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes\n */\nexport function listOutgoingLinkTypes($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _listOutgoingLinkTypes, ...args);\n}\nconst _getOutgoingLinkType = [0, \"/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes/{2}\", 2];\n/**\n * Get an outgoing link for an object type.\n *\n * @public\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}\n */\nexport function getOutgoingLinkType($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getOutgoingLinkType, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,KAAK,GAAG,CAAC,CAAC,EAAE,gCAAgC,EAAE,CAAC,CAAC;AACtD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,KAAK,EAAE,GAAGG,IAAI,CAAC;AACtD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,oCAAoC,EAAE,CAAC,CAAC;AACzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,cAAc,GAAG,CAAC,CAAC,EAAE,8CAA8C,EAAE,CAAC,CAAC;AAC7E;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,cAAc,EAAE,GAAGH,IAAI,CAAC;AAC/D;AACA,MAAMK,gBAAgB,GAAG,CAAC,CAAC,EAAE,iDAAiD,EAAE,CAAC,CAAC;AAClF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC3C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,gBAAgB,EAAE,GAAGL,IAAI,CAAC;AACjE;AACA,MAAMO,gBAAgB,GAAG,CAAC,CAAC,EAAE,iDAAiD,EAAE,CAAC,CAAC;AAClF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,eAAeA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC3C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,gBAAgB,EAAE,GAAGP,IAAI,CAAC;AACjE;AACA,MAAMS,sBAAsB,GAAG,CAAC,CAAC,EAAE,sDAAsD,EAAE,CAAC,CAAC;AAC7F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,qBAAqBA,CAACX,IAAI,EAAE,GAAGC,IAAI,EAAE;EACjD,OAAOJ,qBAAqB,CAACG,IAAI,EAAEU,sBAAsB,EAAE,GAAGT,IAAI,CAAC;AACvE;AACA,MAAMW,oBAAoB,GAAG,CAAC,CAAC,EAAE,0DAA0D,EAAE,CAAC,CAAC;AAC/F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAACb,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEY,oBAAoB,EAAE,GAAGX,IAAI,CAAC;AACrE","ignoreList":[]}
|
|
@@ -360,11 +360,13 @@ export interface AggregationDurationGrouping {
|
|
|
360
360
|
/**
|
|
361
361
|
* Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.
|
|
362
362
|
When grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.
|
|
363
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
363
364
|
*
|
|
364
365
|
* Log Safety: UNSAFE
|
|
365
366
|
*/
|
|
366
367
|
export interface AggregationDurationGroupingV2 {
|
|
367
|
-
field
|
|
368
|
+
field?: PropertyApiName;
|
|
369
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
368
370
|
value: number;
|
|
369
371
|
unit: TimeUnit;
|
|
370
372
|
}
|
|
@@ -378,12 +380,14 @@ export interface AggregationExactGrouping {
|
|
|
378
380
|
maxGroupCount?: number;
|
|
379
381
|
}
|
|
380
382
|
/**
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
383
|
+
* Divides objects into groups according to an exact value.
|
|
384
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
385
|
+
*
|
|
386
|
+
* Log Safety: UNSAFE
|
|
387
|
+
*/
|
|
385
388
|
export interface AggregationExactGroupingV2 {
|
|
386
|
-
field
|
|
389
|
+
field?: PropertyApiName;
|
|
390
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
387
391
|
maxGroupCount?: number;
|
|
388
392
|
defaultValue?: string;
|
|
389
393
|
includeNullValues?: boolean;
|
|
@@ -398,12 +402,14 @@ export interface AggregationFixedWidthGrouping {
|
|
|
398
402
|
fixedWidth: number;
|
|
399
403
|
}
|
|
400
404
|
/**
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
+
* Divides objects into groups with the specified width.
|
|
406
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
407
|
+
*
|
|
408
|
+
* Log Safety: UNSAFE
|
|
409
|
+
*/
|
|
405
410
|
export interface AggregationFixedWidthGroupingV2 {
|
|
406
|
-
field
|
|
411
|
+
field?: PropertyApiName;
|
|
412
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
407
413
|
fixedWidth: number;
|
|
408
414
|
}
|
|
409
415
|
/**
|
|
@@ -505,12 +511,14 @@ export interface AggregationRangesGrouping {
|
|
|
505
511
|
ranges: Array<AggregationRange>;
|
|
506
512
|
}
|
|
507
513
|
/**
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
514
|
+
* Divides objects into groups according to specified ranges.
|
|
515
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
516
|
+
*
|
|
517
|
+
* Log Safety: UNSAFE
|
|
518
|
+
*/
|
|
512
519
|
export interface AggregationRangesGroupingV2 {
|
|
513
|
-
field
|
|
520
|
+
field?: PropertyApiName;
|
|
521
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
514
522
|
ranges: Array<AggregationRangeV2>;
|
|
515
523
|
}
|
|
516
524
|
/**
|
|
@@ -669,22 +677,26 @@ export interface ApproximateDistinctAggregation {
|
|
|
669
677
|
name?: AggregationMetricName;
|
|
670
678
|
}
|
|
671
679
|
/**
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
680
|
+
* Computes an approximate number of distinct values for the provided field.
|
|
681
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
682
|
+
*
|
|
683
|
+
* Log Safety: UNSAFE
|
|
684
|
+
*/
|
|
676
685
|
export interface ApproximateDistinctAggregationV2 {
|
|
677
|
-
field
|
|
686
|
+
field?: PropertyApiName;
|
|
687
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
678
688
|
name?: AggregationMetricName;
|
|
679
689
|
direction?: OrderByDirection;
|
|
680
690
|
}
|
|
681
691
|
/**
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
692
|
+
* Computes the approximate percentile value for the provided field. Requires Object Storage V2.
|
|
693
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
694
|
+
*
|
|
695
|
+
* Log Safety: UNSAFE
|
|
696
|
+
*/
|
|
686
697
|
export interface ApproximatePercentileAggregationV2 {
|
|
687
|
-
field
|
|
698
|
+
field?: PropertyApiName;
|
|
699
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
688
700
|
name?: AggregationMetricName;
|
|
689
701
|
approximatePercentile: number;
|
|
690
702
|
direction?: OrderByDirection;
|
|
@@ -836,12 +848,14 @@ export interface AvgAggregation {
|
|
|
836
848
|
name?: AggregationMetricName;
|
|
837
849
|
}
|
|
838
850
|
/**
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
851
|
+
* Computes the average value for the provided field.
|
|
852
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
853
|
+
*
|
|
854
|
+
* Log Safety: UNSAFE
|
|
855
|
+
*/
|
|
843
856
|
export interface AvgAggregationV2 {
|
|
844
|
-
field
|
|
857
|
+
field?: PropertyApiName;
|
|
858
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
845
859
|
name?: AggregationMetricName;
|
|
846
860
|
direction?: OrderByDirection;
|
|
847
861
|
}
|
|
@@ -1608,12 +1622,15 @@ export interface ErrorComputingSecurity {
|
|
|
1608
1622
|
*/
|
|
1609
1623
|
export type ErrorName = LooselyBrandedString<"ErrorName">;
|
|
1610
1624
|
/**
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1625
|
+
* Computes an exact number of distinct values for the provided field. May be slower than an approximate
|
|
1626
|
+
distinct aggregation. Requires Object Storage V2.
|
|
1627
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
1628
|
+
*
|
|
1629
|
+
* Log Safety: UNSAFE
|
|
1630
|
+
*/
|
|
1615
1631
|
export interface ExactDistinctAggregationV2 {
|
|
1616
|
-
field
|
|
1632
|
+
field?: PropertyApiName;
|
|
1633
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
1617
1634
|
name?: AggregationMetricName;
|
|
1618
1635
|
direction?: OrderByDirection;
|
|
1619
1636
|
}
|
|
@@ -1825,6 +1842,24 @@ export interface GetActionTypeByRidBatchRequestElement {
|
|
|
1825
1842
|
export interface GetActionTypeByRidBatchResponse {
|
|
1826
1843
|
data: Array<ActionTypeV2>;
|
|
1827
1844
|
}
|
|
1845
|
+
/**
|
|
1846
|
+
* Log Safety: SAFE
|
|
1847
|
+
*/
|
|
1848
|
+
export interface GetObjectTypeByRidBatchRequest {
|
|
1849
|
+
requests: Array<GetObjectTypeByRidBatchRequestElement>;
|
|
1850
|
+
}
|
|
1851
|
+
/**
|
|
1852
|
+
* Log Safety: SAFE
|
|
1853
|
+
*/
|
|
1854
|
+
export interface GetObjectTypeByRidBatchRequestElement {
|
|
1855
|
+
objectTypeRid: ObjectTypeRid;
|
|
1856
|
+
}
|
|
1857
|
+
/**
|
|
1858
|
+
* Log Safety: UNSAFE
|
|
1859
|
+
*/
|
|
1860
|
+
export interface GetObjectTypeByRidBatchResponse {
|
|
1861
|
+
data: Array<ObjectTypeV2>;
|
|
1862
|
+
}
|
|
1828
1863
|
/**
|
|
1829
1864
|
* Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could
|
|
1830
1865
|
explode the cardinality.
|
|
@@ -2737,12 +2772,14 @@ export interface MaxAggregation {
|
|
|
2737
2772
|
name?: AggregationMetricName;
|
|
2738
2773
|
}
|
|
2739
2774
|
/**
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2775
|
+
* Computes the maximum value for the provided field.
|
|
2776
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
2777
|
+
*
|
|
2778
|
+
* Log Safety: UNSAFE
|
|
2779
|
+
*/
|
|
2744
2780
|
export interface MaxAggregationV2 {
|
|
2745
|
-
field
|
|
2781
|
+
field?: PropertyApiName;
|
|
2782
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
2746
2783
|
name?: AggregationMetricName;
|
|
2747
2784
|
direction?: OrderByDirection;
|
|
2748
2785
|
}
|
|
@@ -2772,12 +2809,14 @@ export interface MinAggregation {
|
|
|
2772
2809
|
name?: AggregationMetricName;
|
|
2773
2810
|
}
|
|
2774
2811
|
/**
|
|
2775
|
-
|
|
2776
|
-
|
|
2777
|
-
|
|
2778
|
-
|
|
2812
|
+
* Computes the minimum value for the provided field.
|
|
2813
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
2814
|
+
*
|
|
2815
|
+
* Log Safety: UNSAFE
|
|
2816
|
+
*/
|
|
2779
2817
|
export interface MinAggregationV2 {
|
|
2780
|
-
field
|
|
2818
|
+
field?: PropertyApiName;
|
|
2819
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
2781
2820
|
name?: AggregationMetricName;
|
|
2782
2821
|
direction?: OrderByDirection;
|
|
2783
2822
|
}
|
|
@@ -4464,48 +4503,50 @@ export type QueryDataType = ({
|
|
|
4464
4503
|
} & OntologyInterfaceObjectType) | ({
|
|
4465
4504
|
type: "struct";
|
|
4466
4505
|
} & QueryStructType) | ({
|
|
4467
|
-
type: "set";
|
|
4468
|
-
} & QuerySetType) | ({
|
|
4469
|
-
type: "void";
|
|
4470
|
-
} & _Core.VoidType) | ({
|
|
4471
4506
|
type: "string";
|
|
4472
4507
|
} & _Core.StringType) | ({
|
|
4473
|
-
type: "entrySet";
|
|
4474
|
-
} & EntrySetType) | ({
|
|
4475
|
-
type: "double";
|
|
4476
|
-
} & _Core.DoubleType) | ({
|
|
4477
4508
|
type: "integer";
|
|
4478
4509
|
} & _Core.IntegerType) | ({
|
|
4479
4510
|
type: "threeDimensionalAggregation";
|
|
4480
4511
|
} & ThreeDimensionalAggregation) | ({
|
|
4481
|
-
type: "union";
|
|
4482
|
-
} & QueryUnionType) | ({
|
|
4483
4512
|
type: "float";
|
|
4484
4513
|
} & _Core.FloatType) | ({
|
|
4485
4514
|
type: "long";
|
|
4486
4515
|
} & _Core.LongType) | ({
|
|
4487
|
-
type: "boolean";
|
|
4488
|
-
} & _Core.BooleanType) | ({
|
|
4489
4516
|
type: "unsupported";
|
|
4490
4517
|
} & _Core.UnsupportedType) | ({
|
|
4491
4518
|
type: "attachment";
|
|
4492
4519
|
} & _Core.AttachmentType) | ({
|
|
4493
|
-
type: "mediaReference";
|
|
4494
|
-
} & _Core.MediaReferenceType) | ({
|
|
4495
|
-
type: "null";
|
|
4496
|
-
} & _Core.NullType) | ({
|
|
4497
4520
|
type: "array";
|
|
4498
4521
|
} & QueryArrayType) | ({
|
|
4499
4522
|
type: "objectSet";
|
|
4500
4523
|
} & OntologyObjectSetType) | ({
|
|
4501
4524
|
type: "twoDimensionalAggregation";
|
|
4502
4525
|
} & TwoDimensionalAggregation) | ({
|
|
4526
|
+
type: "typeReference";
|
|
4527
|
+
} & QueryTypeReferenceType) | ({
|
|
4528
|
+
type: "timestamp";
|
|
4529
|
+
} & _Core.TimestampType) | ({
|
|
4530
|
+
type: "set";
|
|
4531
|
+
} & QuerySetType) | ({
|
|
4532
|
+
type: "void";
|
|
4533
|
+
} & _Core.VoidType) | ({
|
|
4534
|
+
type: "entrySet";
|
|
4535
|
+
} & EntrySetType) | ({
|
|
4536
|
+
type: "double";
|
|
4537
|
+
} & _Core.DoubleType) | ({
|
|
4538
|
+
type: "union";
|
|
4539
|
+
} & QueryUnionType) | ({
|
|
4540
|
+
type: "boolean";
|
|
4541
|
+
} & _Core.BooleanType) | ({
|
|
4542
|
+
type: "mediaReference";
|
|
4543
|
+
} & _Core.MediaReferenceType) | ({
|
|
4544
|
+
type: "null";
|
|
4545
|
+
} & _Core.NullType) | ({
|
|
4503
4546
|
type: "interfaceObjectSet";
|
|
4504
4547
|
} & OntologyInterfaceObjectSetType) | ({
|
|
4505
4548
|
type: "object";
|
|
4506
|
-
} & OntologyObjectType)
|
|
4507
|
-
type: "timestamp";
|
|
4508
|
-
} & _Core.TimestampType);
|
|
4549
|
+
} & OntologyObjectType);
|
|
4509
4550
|
/**
|
|
4510
4551
|
* Details about the output of a query.
|
|
4511
4552
|
*
|
|
@@ -4573,6 +4614,15 @@ export interface QueryType {
|
|
|
4573
4614
|
rid: FunctionRid;
|
|
4574
4615
|
version: FunctionVersion;
|
|
4575
4616
|
}
|
|
4617
|
+
/**
|
|
4618
|
+
* A reference to a type that is defined in the typeReferences map of the enclosing Query.
|
|
4619
|
+
This enables support for recursive type definitions where a type may reference itself.
|
|
4620
|
+
*
|
|
4621
|
+
* Log Safety: SAFE
|
|
4622
|
+
*/
|
|
4623
|
+
export interface QueryTypeReferenceType {
|
|
4624
|
+
typeId: TypeReferenceIdentifier;
|
|
4625
|
+
}
|
|
4576
4626
|
/**
|
|
4577
4627
|
* Represents a query type in the Ontology.
|
|
4578
4628
|
*
|
|
@@ -4586,6 +4636,7 @@ export interface QueryTypeV2 {
|
|
|
4586
4636
|
output: QueryDataType;
|
|
4587
4637
|
rid: FunctionRid;
|
|
4588
4638
|
version: FunctionVersion;
|
|
4639
|
+
typeReferences: Record<TypeReferenceIdentifier, QueryDataType>;
|
|
4589
4640
|
}
|
|
4590
4641
|
/**
|
|
4591
4642
|
* Log Safety: UNSAFE
|
|
@@ -5502,12 +5553,14 @@ export interface SumAggregation {
|
|
|
5502
5553
|
name?: AggregationMetricName;
|
|
5503
5554
|
}
|
|
5504
5555
|
/**
|
|
5505
|
-
|
|
5506
|
-
|
|
5507
|
-
|
|
5508
|
-
|
|
5556
|
+
* Computes the sum of values for the provided field.
|
|
5557
|
+
Either field or propertyIdentifier must be supplied, but not both.
|
|
5558
|
+
*
|
|
5559
|
+
* Log Safety: UNSAFE
|
|
5560
|
+
*/
|
|
5509
5561
|
export interface SumAggregationV2 {
|
|
5510
|
-
field
|
|
5562
|
+
field?: PropertyApiName;
|
|
5563
|
+
propertyIdentifier?: PropertyIdentifier;
|
|
5511
5564
|
name?: AggregationMetricName;
|
|
5512
5565
|
direction?: OrderByDirection;
|
|
5513
5566
|
}
|
|
@@ -5703,6 +5756,13 @@ export interface TypeClass {
|
|
|
5703
5756
|
kind: string;
|
|
5704
5757
|
name: string;
|
|
5705
5758
|
}
|
|
5759
|
+
/**
|
|
5760
|
+
* The unique identifier of a type reference. This identifier is used to look up the
|
|
5761
|
+
type definition in the typeReferences map of the enclosing Query.
|
|
5762
|
+
*
|
|
5763
|
+
* Log Safety: SAFE
|
|
5764
|
+
*/
|
|
5765
|
+
export type TypeReferenceIdentifier = LooselyBrandedString<"TypeReferenceIdentifier">;
|
|
5706
5766
|
/**
|
|
5707
5767
|
* The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.
|
|
5708
5768
|
This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.
|