@osdk/foundry.ontologies 2.12.0 → 2.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -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
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2024 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
|
|
17
|
+
//
|
|
18
|
+
const _list = [0, "/v2/ontologies/{0}/objectTypes", 2];
|
|
19
|
+
/**
|
|
20
|
+
* Lists the object types for the given Ontology.
|
|
21
|
+
*
|
|
22
|
+
* Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are
|
|
23
|
+
* more results available, at least one result will be present in the
|
|
24
|
+
* response.
|
|
25
|
+
*
|
|
26
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
27
|
+
*
|
|
28
|
+
* @public
|
|
29
|
+
*
|
|
30
|
+
* Required Scopes: [api:ontologies-read]
|
|
31
|
+
* URL: /v2/ontologies/{ontology}/objectTypes
|
|
32
|
+
*/
|
|
33
|
+
export function list($ctx, ...args) {
|
|
34
|
+
return $foundryPlatformFetch($ctx, _list, ...args);
|
|
35
|
+
}
|
|
36
|
+
const _get = [0, "/v2/ontologies/{0}/objectTypes/{1}"];
|
|
37
|
+
/**
|
|
38
|
+
* Gets a specific object type with the given API name.
|
|
39
|
+
*
|
|
40
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
41
|
+
*
|
|
42
|
+
* @public
|
|
43
|
+
*
|
|
44
|
+
* Required Scopes: [api:ontologies-read]
|
|
45
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}
|
|
46
|
+
*/
|
|
47
|
+
export function get($ctx, ...args) {
|
|
48
|
+
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
49
|
+
}
|
|
50
|
+
const _getFullMetadata = [0, "/v2/ontologies/{0}/objectTypes/{1}/fullMetadata", 2];
|
|
51
|
+
/**
|
|
52
|
+
* Gets the full metadata for a specific object type with the given API name.
|
|
53
|
+
*
|
|
54
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
55
|
+
*
|
|
56
|
+
* @alpha
|
|
57
|
+
*
|
|
58
|
+
* Required Scopes: [api:ontologies-read]
|
|
59
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata
|
|
60
|
+
*/
|
|
61
|
+
export function getFullMetadata($ctx, ...args) {
|
|
62
|
+
return $foundryPlatformFetch($ctx, _getFullMetadata, ...args);
|
|
63
|
+
}
|
|
64
|
+
const _listOutgoingLinkTypes = [0, "/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes", 2];
|
|
65
|
+
/**
|
|
66
|
+
* List the outgoing links for an object type.
|
|
67
|
+
*
|
|
68
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
69
|
+
* following operation scopes: `api:ontologies-read`.
|
|
70
|
+
*
|
|
71
|
+
* @public
|
|
72
|
+
*
|
|
73
|
+
* Required Scopes: [api:ontologies-read]
|
|
74
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes
|
|
75
|
+
*/
|
|
76
|
+
export function listOutgoingLinkTypes($ctx, ...args) {
|
|
77
|
+
return $foundryPlatformFetch($ctx, _listOutgoingLinkTypes, ...args);
|
|
78
|
+
}
|
|
79
|
+
const _getOutgoingLinkType = [0, "/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes/{2}"];
|
|
80
|
+
/**
|
|
81
|
+
* Get an outgoing link for an object type.
|
|
82
|
+
*
|
|
83
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
84
|
+
* following operation scopes: `api:ontologies-read`.
|
|
85
|
+
*
|
|
86
|
+
* @public
|
|
87
|
+
*
|
|
88
|
+
* Required Scopes: [api:ontologies-read]
|
|
89
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}
|
|
90
|
+
*/
|
|
91
|
+
export function getOutgoingLinkType($ctx, ...args) {
|
|
92
|
+
return $foundryPlatformFetch($ctx, _getOutgoingLinkType, ...args);
|
|
93
|
+
}
|
|
94
|
+
//# sourceMappingURL=ObjectTypeV2.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ObjectTypeV2.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_list","list","$ctx","args","_get","get","_getFullMetadata","getFullMetadata","_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 * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\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}\"];\n/**\n * Gets a specific object type with the given API name.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\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 * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\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 _listOutgoingLinkTypes = [0, \"/v2/ontologies/{0}/objectTypes/{1}/outgoingLinkTypes\", 2];\n/**\n * List the outgoing links for an object type.\n *\n * Third-party applications using this endpoint via OAuth2 must request the\n * following operation scopes: `api:ontologies-read`.\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}\"];\n/**\n * Get an outgoing link for an object type.\n *\n * Third-party applications using this endpoint via OAuth2 must request the\n * following operation scopes: `api:ontologies-read`.\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;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,CAAC;AACtD;AACA;AACA;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;AACA;AACA,OAAO,SAASC,eAAeA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC3C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,gBAAgB,EAAE,GAAGH,IAAI,CAAC;AACjE;AACA,MAAMK,sBAAsB,GAAG,CAAC,CAAC,EAAE,sDAAsD,EAAE,CAAC,CAAC;AAC7F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,qBAAqBA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACjD,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,sBAAsB,EAAE,GAAGL,IAAI,CAAC;AACvE;AACA,MAAMO,oBAAoB,GAAG,CAAC,CAAC,EAAE,0DAA0D,CAAC;AAC5F;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,mBAAmBA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/C,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,oBAAoB,EAAE,GAAGP,IAAI,CAAC;AACrE","ignoreList":[]}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import type * as _Core from "@osdk/foundry.core";
|
|
2
|
+
import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
|
|
3
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
4
|
+
import type * as _Ontologies from "../_components.js";
|
|
5
|
+
/**
|
|
6
|
+
* :::callout{theme=warning title=Warning}
|
|
7
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
8
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
9
|
+
* :::
|
|
10
|
+
*
|
|
11
|
+
* Lists the interface types for the given Ontology.
|
|
12
|
+
*
|
|
13
|
+
* Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
|
|
14
|
+
* results available, at least one result will be present in the response.
|
|
15
|
+
*
|
|
16
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
17
|
+
*
|
|
18
|
+
* @beta
|
|
19
|
+
*
|
|
20
|
+
* Required Scopes: [api:ontologies-read]
|
|
21
|
+
* URL: /v2/ontologies/{ontology}/interfaceTypes
|
|
22
|
+
*/
|
|
23
|
+
export declare function list($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
24
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
25
|
+
$queryParams?: {
|
|
26
|
+
pageSize?: _Core.PageSize | undefined;
|
|
27
|
+
pageToken?: _Core.PageToken | undefined;
|
|
28
|
+
preview?: _Core.PreviewMode | undefined;
|
|
29
|
+
}
|
|
30
|
+
]): Promise<_Ontologies.ListInterfaceTypesResponse>;
|
|
31
|
+
/**
|
|
32
|
+
* :::callout{theme=warning title=Warning}
|
|
33
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
34
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
35
|
+
* :::
|
|
36
|
+
*
|
|
37
|
+
* Gets a specific interface type with the given API name.
|
|
38
|
+
*
|
|
39
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
40
|
+
*
|
|
41
|
+
* @beta
|
|
42
|
+
*
|
|
43
|
+
* Required Scopes: [api:ontologies-read]
|
|
44
|
+
* URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}
|
|
45
|
+
*/
|
|
46
|
+
export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
47
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
48
|
+
interfaceType: _Ontologies.InterfaceTypeApiName,
|
|
49
|
+
$queryParams?: {
|
|
50
|
+
preview?: _Core.PreviewMode | undefined;
|
|
51
|
+
}
|
|
52
|
+
]): Promise<_Ontologies.InterfaceType>;
|
|
53
|
+
/**
|
|
54
|
+
* :::callout{theme=warning title=Warning}
|
|
55
|
+
* This endpoint will be removed once TS OSDK is updated to use `objectSets/loadObjects` with interface object
|
|
56
|
+
* sets.
|
|
57
|
+
* :::
|
|
58
|
+
* :::callout{theme=warning title=Warning}
|
|
59
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
60
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
61
|
+
* :::
|
|
62
|
+
*
|
|
63
|
+
* Search for objects in the specified ontology and interface type. Any properties specified in the "where" or
|
|
64
|
+
* "orderBy" parameters must be shared property type API names defined on the interface. The following search
|
|
65
|
+
* queries are supported:
|
|
66
|
+
*
|
|
67
|
+
* | Query type | Description | Supported Types |
|
|
68
|
+
* |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
|
|
69
|
+
* | lt | The provided property is less than the provided value. | number, string, date, timestamp |
|
|
70
|
+
* | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
|
|
71
|
+
* | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
|
|
72
|
+
* | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
|
|
73
|
+
* | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
|
|
74
|
+
* | isNull | The provided property is (or is not) null. | all |
|
|
75
|
+
* | contains | The provided property contains the provided value. | array |
|
|
76
|
+
* | not | The sub-query does not match. | N/A (applied on a query) |
|
|
77
|
+
* | and | All the sub-queries match. | N/A (applied on queries) |
|
|
78
|
+
* | or | At least one of the sub-queries match. | N/A (applied on queries) |
|
|
79
|
+
* | startsWith | The provided property starts with the provided term. | string |
|
|
80
|
+
* | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
|
|
81
|
+
* | containsAllTermsInOrder | The provided property contains the provided terms as a substring. | string |
|
|
82
|
+
* | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
|
|
83
|
+
* | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
|
|
84
|
+
*
|
|
85
|
+
* Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored.
|
|
86
|
+
* Partial terms are not matched by terms filters except where explicitly noted.
|
|
87
|
+
*
|
|
88
|
+
* Attempting to use an unsupported query will result in a validation error. Third-party applications using this
|
|
89
|
+
* endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
90
|
+
*
|
|
91
|
+
* @alpha
|
|
92
|
+
*
|
|
93
|
+
* Required Scopes: [api:ontologies-read]
|
|
94
|
+
* URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search
|
|
95
|
+
*/
|
|
96
|
+
export declare function search($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
97
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
98
|
+
interfaceType: _Ontologies.InterfaceTypeApiName,
|
|
99
|
+
$body: _Ontologies.SearchObjectsForInterfaceRequest,
|
|
100
|
+
$queryParams?: {
|
|
101
|
+
preview?: _Core.PreviewMode | undefined;
|
|
102
|
+
}
|
|
103
|
+
]): Promise<_Ontologies.SearchObjectsResponseV2>;
|
|
104
|
+
/**
|
|
105
|
+
* :::callout{theme=warning title=Warning}
|
|
106
|
+
* This endpoint will be removed once TS OSDK is updated to use `objectSets/aggregate` with interface object
|
|
107
|
+
* sets.
|
|
108
|
+
* :::
|
|
109
|
+
* :::callout{theme=warning title=Warning}
|
|
110
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
111
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
112
|
+
* :::
|
|
113
|
+
*
|
|
114
|
+
* Perform functions on object fields in the specified ontology and of the specified interface type. Any
|
|
115
|
+
* properties specified in the query must be shared property type API names defined on the interface.
|
|
116
|
+
*
|
|
117
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
118
|
+
*
|
|
119
|
+
* @alpha
|
|
120
|
+
*
|
|
121
|
+
* Required Scopes: [api:ontologies-read]
|
|
122
|
+
* URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate
|
|
123
|
+
*/
|
|
124
|
+
export declare function aggregate($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
125
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
126
|
+
interfaceType: _Ontologies.InterfaceTypeApiName,
|
|
127
|
+
$body: _Ontologies.AggregateObjectsRequestV2,
|
|
128
|
+
$queryParams?: {
|
|
129
|
+
preview?: _Core.PreviewMode | undefined;
|
|
130
|
+
}
|
|
131
|
+
]): Promise<_Ontologies.AggregateObjectsResponseV2>;
|
|
132
|
+
//# sourceMappingURL=OntologyInterface.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OntologyInterface.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyInterface.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,WAAW,MAAM,mBAAmB,CAAC;AAetD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IAExC,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QACtC,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QACxC,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAEjD;AAUD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,aAAa,EAAE,WAAW,CAAC,oBAAoB;IAE/C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAEpC;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,aAAa,EAAE,WAAW,CAAC,oBAAoB;IAC/C,KAAK,EAAE,WAAW,CAAC,gCAAgC;IACnD,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAE9C;AAWD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,aAAa,EAAE,WAAW,CAAC,oBAAoB;IAC/C,KAAK,EAAE,WAAW,CAAC,yBAAyB;IAC5C,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAA;KAAE;CAC3D,GACA,OAAO,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAEjD"}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2024 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
|
|
17
|
+
//
|
|
18
|
+
const _list = [0, "/v2/ontologies/{0}/interfaceTypes", 2];
|
|
19
|
+
/**
|
|
20
|
+
* :::callout{theme=warning title=Warning}
|
|
21
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
22
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
23
|
+
* :::
|
|
24
|
+
*
|
|
25
|
+
* Lists the interface types for the given Ontology.
|
|
26
|
+
*
|
|
27
|
+
* Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
|
|
28
|
+
* results available, at least one result will be present in the response.
|
|
29
|
+
*
|
|
30
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
31
|
+
*
|
|
32
|
+
* @beta
|
|
33
|
+
*
|
|
34
|
+
* Required Scopes: [api:ontologies-read]
|
|
35
|
+
* URL: /v2/ontologies/{ontology}/interfaceTypes
|
|
36
|
+
*/
|
|
37
|
+
export function list($ctx, ...args) {
|
|
38
|
+
return $foundryPlatformFetch($ctx, _list, ...args);
|
|
39
|
+
}
|
|
40
|
+
const _get = [0, "/v2/ontologies/{0}/interfaceTypes/{1}", 2];
|
|
41
|
+
/**
|
|
42
|
+
* :::callout{theme=warning title=Warning}
|
|
43
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
44
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
45
|
+
* :::
|
|
46
|
+
*
|
|
47
|
+
* Gets a specific interface type with the given API name.
|
|
48
|
+
*
|
|
49
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
50
|
+
*
|
|
51
|
+
* @beta
|
|
52
|
+
*
|
|
53
|
+
* Required Scopes: [api:ontologies-read]
|
|
54
|
+
* URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}
|
|
55
|
+
*/
|
|
56
|
+
export function get($ctx, ...args) {
|
|
57
|
+
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
58
|
+
}
|
|
59
|
+
const _search = [1, "/v2/ontologies/{0}/interfaces/{1}/search", 3];
|
|
60
|
+
/**
|
|
61
|
+
* :::callout{theme=warning title=Warning}
|
|
62
|
+
* This endpoint will be removed once TS OSDK is updated to use `objectSets/loadObjects` with interface object
|
|
63
|
+
* sets.
|
|
64
|
+
* :::
|
|
65
|
+
* :::callout{theme=warning title=Warning}
|
|
66
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
67
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
68
|
+
* :::
|
|
69
|
+
*
|
|
70
|
+
* Search for objects in the specified ontology and interface type. Any properties specified in the "where" or
|
|
71
|
+
* "orderBy" parameters must be shared property type API names defined on the interface. The following search
|
|
72
|
+
* queries are supported:
|
|
73
|
+
*
|
|
74
|
+
* | Query type | Description | Supported Types |
|
|
75
|
+
* |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
|
|
76
|
+
* | lt | The provided property is less than the provided value. | number, string, date, timestamp |
|
|
77
|
+
* | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
|
|
78
|
+
* | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
|
|
79
|
+
* | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
|
|
80
|
+
* | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
|
|
81
|
+
* | isNull | The provided property is (or is not) null. | all |
|
|
82
|
+
* | contains | The provided property contains the provided value. | array |
|
|
83
|
+
* | not | The sub-query does not match. | N/A (applied on a query) |
|
|
84
|
+
* | and | All the sub-queries match. | N/A (applied on queries) |
|
|
85
|
+
* | or | At least one of the sub-queries match. | N/A (applied on queries) |
|
|
86
|
+
* | startsWith | The provided property starts with the provided term. | string |
|
|
87
|
+
* | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
|
|
88
|
+
* | containsAllTermsInOrder | The provided property contains the provided terms as a substring. | string |
|
|
89
|
+
* | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
|
|
90
|
+
* | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
|
|
91
|
+
*
|
|
92
|
+
* Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored.
|
|
93
|
+
* Partial terms are not matched by terms filters except where explicitly noted.
|
|
94
|
+
*
|
|
95
|
+
* Attempting to use an unsupported query will result in a validation error. Third-party applications using this
|
|
96
|
+
* endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
97
|
+
*
|
|
98
|
+
* @alpha
|
|
99
|
+
*
|
|
100
|
+
* Required Scopes: [api:ontologies-read]
|
|
101
|
+
* URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search
|
|
102
|
+
*/
|
|
103
|
+
export function search($ctx, ...args) {
|
|
104
|
+
return $foundryPlatformFetch($ctx, _search, ...args);
|
|
105
|
+
}
|
|
106
|
+
const _aggregate = [1, "/v2/ontologies/{0}/interfaces/{1}/aggregate", 3];
|
|
107
|
+
/**
|
|
108
|
+
* :::callout{theme=warning title=Warning}
|
|
109
|
+
* This endpoint will be removed once TS OSDK is updated to use `objectSets/aggregate` with interface object
|
|
110
|
+
* sets.
|
|
111
|
+
* :::
|
|
112
|
+
* :::callout{theme=warning title=Warning}
|
|
113
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
114
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
115
|
+
* :::
|
|
116
|
+
*
|
|
117
|
+
* Perform functions on object fields in the specified ontology and of the specified interface type. Any
|
|
118
|
+
* properties specified in the query must be shared property type API names defined on the interface.
|
|
119
|
+
*
|
|
120
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
121
|
+
*
|
|
122
|
+
* @alpha
|
|
123
|
+
*
|
|
124
|
+
* Required Scopes: [api:ontologies-read]
|
|
125
|
+
* URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate
|
|
126
|
+
*/
|
|
127
|
+
export function aggregate($ctx, ...args) {
|
|
128
|
+
return $foundryPlatformFetch($ctx, _aggregate, ...args);
|
|
129
|
+
}
|
|
130
|
+
//# sourceMappingURL=OntologyInterface.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OntologyInterface.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_list","list","$ctx","args","_get","get","_search","search","_aggregate","aggregate"],"sources":["OntologyInterface.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}/interfaceTypes\", 2];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Lists the interface types for the given Ontology.\n *\n * Each page may be smaller than the requested page size. However, it is guaranteed that if there are more\n * results available, at least one result will be present in the response.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaceTypes\n */\nexport function list($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _list, ...args);\n}\nconst _get = [0, \"/v2/ontologies/{0}/interfaceTypes/{1}\", 2];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Gets a specific interface type with the given API name.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @beta\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _search = [1, \"/v2/ontologies/{0}/interfaces/{1}/search\", 3];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint will be removed once TS OSDK is updated to use `objectSets/loadObjects` with interface object\n * sets.\n * :::\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Search for objects in the specified ontology and interface type. Any properties specified in the \"where\" or\n * \"orderBy\" parameters must be shared property type API names defined on the interface. The following search\n * queries are supported:\n *\n * | Query type | Description | Supported Types |\n * |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|\n * | lt | The provided property is less than the provided value. | number, string, date, timestamp |\n * | gt | The provided property is greater than the provided value. | number, string, date, timestamp |\n * | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |\n * | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |\n * | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |\n * | isNull | The provided property is (or is not) null. | all |\n * | contains | The provided property contains the provided value. | array |\n * | not | The sub-query does not match. | N/A (applied on a query) |\n * | and | All the sub-queries match. | N/A (applied on queries) |\n * | or | At least one of the sub-queries match. | N/A (applied on queries) |\n * | startsWith | The provided property starts with the provided term. | string |\n * | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |\n * | containsAllTermsInOrder | The provided property contains the provided terms as a substring. | string |\n * | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n * | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |\n *\n * Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\n * Partial terms are not matched by terms filters except where explicitly noted.\n *\n * Attempting to use an unsupported query will result in a validation error. Third-party applications using this\n * endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search\n */\nexport function search($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _search, ...args);\n}\nconst _aggregate = [1, \"/v2/ontologies/{0}/interfaces/{1}/aggregate\", 3];\n/**\n * :::callout{theme=warning title=Warning}\n * This endpoint will be removed once TS OSDK is updated to use `objectSets/aggregate` with interface object\n * sets.\n * :::\n * :::callout{theme=warning title=Warning}\n * This endpoint is in preview and may be modified or removed at any time.\n * To use this endpoint, add `preview=true` to the request query parameters.\n * :::\n *\n * Perform functions on object fields in the specified ontology and of the specified interface type. Any\n * properties specified in the query must be shared property type API names defined on the interface.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n *\n * @alpha\n *\n * Required Scopes: [api:ontologies-read]\n * URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate\n */\nexport function aggregate($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _aggregate, ...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,mCAAmC,EAAE,CAAC,CAAC;AACzD;AACA;AACA;AACA;AACA;AACA;AACA;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,uCAAuC,EAAE,CAAC,CAAC;AAC5D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;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,OAAO,GAAG,CAAC,CAAC,EAAE,0CAA0C,EAAE,CAAC,CAAC;AAClE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,OAAO,EAAE,GAAGH,IAAI,CAAC;AACxD;AACA,MAAMK,UAAU,GAAG,CAAC,CAAC,EAAE,6CAA6C,EAAE,CAAC,CAAC;AACxE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,UAAU,EAAE,GAAGL,IAAI,CAAC;AAC3D","ignoreList":[]}
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import type * as _Core from "@osdk/foundry.core";
|
|
2
|
+
import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
|
|
3
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
|
|
4
|
+
import type * as _Ontologies from "../_components.js";
|
|
5
|
+
/**
|
|
6
|
+
* Creates a temporary `ObjectSet` from the given definition.
|
|
7
|
+
*
|
|
8
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
9
|
+
* following operation scopes: `api:ontologies-read api:ontologies-write`.
|
|
10
|
+
*
|
|
11
|
+
* @beta
|
|
12
|
+
*
|
|
13
|
+
* Required Scopes: [api:ontologies-read, api:ontologies-write]
|
|
14
|
+
* URL: /v2/ontologies/{ontology}/objectSets/createTemporary
|
|
15
|
+
*/
|
|
16
|
+
export declare function createTemporary($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
17
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
18
|
+
$body: _Ontologies.CreateTemporaryObjectSetRequestV2
|
|
19
|
+
]): Promise<_Ontologies.CreateTemporaryObjectSetResponseV2>;
|
|
20
|
+
/**
|
|
21
|
+
* Gets the definition of the `ObjectSet` with the given RID.
|
|
22
|
+
*
|
|
23
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
24
|
+
*
|
|
25
|
+
* @alpha
|
|
26
|
+
*
|
|
27
|
+
* Required Scopes: []
|
|
28
|
+
* URL: /v2/ontologies/{ontology}/objectSets/{objectSetRid}
|
|
29
|
+
*/
|
|
30
|
+
export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
31
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
32
|
+
objectSetRid: _Ontologies.ObjectSetRid
|
|
33
|
+
]): Promise<_Ontologies.ObjectSet>;
|
|
34
|
+
/**
|
|
35
|
+
* Load the ontology objects present in the `ObjectSet` from the provided object set definition.
|
|
36
|
+
*
|
|
37
|
+
* For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
|
|
38
|
+
* are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
|
|
39
|
+
*
|
|
40
|
+
* Note that null value properties will not be returned.
|
|
41
|
+
*
|
|
42
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
43
|
+
*
|
|
44
|
+
* @public
|
|
45
|
+
*
|
|
46
|
+
* Required Scopes: [api:ontologies-read]
|
|
47
|
+
* URL: /v2/ontologies/{ontology}/objectSets/loadObjects
|
|
48
|
+
*/
|
|
49
|
+
export declare function load($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
50
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
51
|
+
$body: _Ontologies.LoadObjectSetRequestV2,
|
|
52
|
+
$queryParams?: {
|
|
53
|
+
artifactRepository?: _Ontologies.ArtifactRepositoryRid | undefined;
|
|
54
|
+
packageName?: _Ontologies.SdkPackageName | undefined;
|
|
55
|
+
}
|
|
56
|
+
]): Promise<_Ontologies.LoadObjectSetResponseV2>;
|
|
57
|
+
/**
|
|
58
|
+
* Load the ontology objects present in the `ObjectSet` from the provided object set definition. The resulting
|
|
59
|
+
* objects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped
|
|
60
|
+
* to an interface, in which only the object type properties that implement the properties of any interfaces in its
|
|
61
|
+
* scope are returned. For objects that are scoped to an interface in the result, a mapping from interface to
|
|
62
|
+
* object implementation is returned in order to interpret the objects as the interfaces that they implement.
|
|
63
|
+
*
|
|
64
|
+
* For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
|
|
65
|
+
* are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
|
|
66
|
+
*
|
|
67
|
+
* Note that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)
|
|
68
|
+
* will be prefixed with '$' instead of '\_\_' as is the case in `loadObjects`.
|
|
69
|
+
*
|
|
70
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
71
|
+
*
|
|
72
|
+
* @beta
|
|
73
|
+
*
|
|
74
|
+
* Required Scopes: [api:ontologies-read]
|
|
75
|
+
* URL: /v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes
|
|
76
|
+
*/
|
|
77
|
+
export declare function loadMultipleObjectTypes($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
78
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
79
|
+
$body: _Ontologies.LoadObjectSetV2MultipleObjectTypesRequest,
|
|
80
|
+
$queryParams?: {
|
|
81
|
+
artifactRepository?: _Ontologies.ArtifactRepositoryRid | undefined;
|
|
82
|
+
packageName?: _Ontologies.SdkPackageName | undefined;
|
|
83
|
+
preview?: _Core.PreviewMode | undefined;
|
|
84
|
+
}
|
|
85
|
+
]): Promise<_Ontologies.LoadObjectSetV2MultipleObjectTypesResponse>;
|
|
86
|
+
/**
|
|
87
|
+
* Load the ontology objects present in the `ObjectSet` from the provided object set definition. If the requested
|
|
88
|
+
* object set contains interfaces and the object can be viewed as an interface, it will contain the properties
|
|
89
|
+
* defined by the interface. If not, it will contain the properties defined by its object type. This allows directly
|
|
90
|
+
* loading all objects of an interface where all objects are viewed as the interface, for example.
|
|
91
|
+
*
|
|
92
|
+
* Note that the result object set cannot contain a mix of objects with "interface" properties and "object type"
|
|
93
|
+
* properties. Attempting to load an object set like this will result in an error.
|
|
94
|
+
*
|
|
95
|
+
* For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects
|
|
96
|
+
* are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.
|
|
97
|
+
*
|
|
98
|
+
* Note that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)
|
|
99
|
+
* will be prefixed with '$' instead of '\_\_' as is the case in `/loadObjects`.
|
|
100
|
+
*
|
|
101
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
102
|
+
*
|
|
103
|
+
* @beta
|
|
104
|
+
*
|
|
105
|
+
* Required Scopes: [api:ontologies-read]
|
|
106
|
+
* URL: /v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces
|
|
107
|
+
*/
|
|
108
|
+
export declare function loadObjectsOrInterfaces($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
109
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
110
|
+
$body: _Ontologies.LoadObjectSetV2ObjectsOrInterfacesRequest,
|
|
111
|
+
$queryParams?: {
|
|
112
|
+
artifactRepository?: _Ontologies.ArtifactRepositoryRid | undefined;
|
|
113
|
+
packageName?: _Ontologies.SdkPackageName | undefined;
|
|
114
|
+
preview?: _Core.PreviewMode | undefined;
|
|
115
|
+
}
|
|
116
|
+
]): Promise<_Ontologies.LoadObjectSetV2ObjectsOrInterfacesResponse>;
|
|
117
|
+
/**
|
|
118
|
+
* Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.
|
|
119
|
+
*
|
|
120
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.
|
|
121
|
+
*
|
|
122
|
+
* @public
|
|
123
|
+
*
|
|
124
|
+
* Required Scopes: [api:ontologies-read]
|
|
125
|
+
* URL: /v2/ontologies/{ontology}/objectSets/aggregate
|
|
126
|
+
*/
|
|
127
|
+
export declare function aggregate($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
|
|
128
|
+
ontology: _Ontologies.OntologyIdentifier,
|
|
129
|
+
$body: _Ontologies.AggregateObjectSetRequestV2,
|
|
130
|
+
$queryParams?: {
|
|
131
|
+
artifactRepository?: _Ontologies.ArtifactRepositoryRid | undefined;
|
|
132
|
+
packageName?: _Ontologies.SdkPackageName | undefined;
|
|
133
|
+
}
|
|
134
|
+
]): Promise<_Ontologies.AggregateObjectsResponseV2>;
|
|
135
|
+
//# sourceMappingURL=OntologyObjectSet.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OntologyObjectSet.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyObjectSet.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,WAAW,MAAM,mBAAmB,CAAC;AAWtD;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,KAAK,EAAE,WAAW,CAAC,iCAAiC;CACrD,GACA,OAAO,CAAC,WAAW,CAAC,kCAAkC,CAAC,CAEzD;AASD;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,YAAY,EAAE,WAAW,CAAC,YAAY;CACvC,GACA,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAEhC;AAaD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,KAAK,EAAE,WAAW,CAAC,sBAAsB;IACzC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACnE,WAAW,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC;KACtD;CACF,GACA,OAAO,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAE9C;AAcD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,KAAK,EAAE,WAAW,CAAC,yCAAyC;IAC5D,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACnE,WAAW,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC;QACrD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAEjE;AAcD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,KAAK,EAAE,WAAW,CAAC,yCAAyC;IAC5D,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACnE,WAAW,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC;QACrD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,WAAW,CAAC,0CAA0C,CAAC,CAEjE;AAaD;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,WAAW,CAAC,kBAAkB;IACxC,KAAK,EAAE,WAAW,CAAC,2BAA2B;IAC9C,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACnE,WAAW,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,SAAS,CAAC;KACtD;CACF,GACA,OAAO,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAEjD"}
|