@osdk/internal.foundry.ontologiesv2 0.0.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/README.md +8 -0
- package/build/js/chunk-2MBEHXAZ.cjs +31 -0
- package/build/js/chunk-2MBEHXAZ.cjs.map +1 -0
- package/build/js/chunk-4QLZ4AX4.mjs +31 -0
- package/build/js/chunk-4QLZ4AX4.mjs.map +1 -0
- package/build/js/chunk-6R44KITD.cjs +37 -0
- package/build/js/chunk-6R44KITD.cjs.map +1 -0
- package/build/js/chunk-7EJXI26U.browser.mjs +106 -0
- package/build/js/chunk-7EJXI26U.browser.mjs.map +1 -0
- package/build/js/chunk-7G2FSZUY.cjs +11 -0
- package/build/js/chunk-7G2FSZUY.cjs.map +1 -0
- package/build/js/chunk-7OXPEHNA.mjs +21 -0
- package/build/js/chunk-7OXPEHNA.mjs.map +1 -0
- package/build/js/chunk-A62MJWJL.browser.mjs +31 -0
- package/build/js/chunk-A62MJWJL.browser.mjs.map +1 -0
- package/build/js/chunk-AAFKH4BF.cjs +37 -0
- package/build/js/chunk-AAFKH4BF.cjs.map +1 -0
- package/build/js/chunk-ASOY6GXH.mjs +26 -0
- package/build/js/chunk-ASOY6GXH.mjs.map +1 -0
- package/build/js/chunk-CURT4PAO.mjs +26 -0
- package/build/js/chunk-CURT4PAO.mjs.map +1 -0
- package/build/js/chunk-E66Y73OF.cjs +25 -0
- package/build/js/chunk-E66Y73OF.cjs.map +1 -0
- package/build/js/chunk-HS7GYR5G.cjs +31 -0
- package/build/js/chunk-HS7GYR5G.cjs.map +1 -0
- package/build/js/chunk-J5ACKCFT.browser.mjs +21 -0
- package/build/js/chunk-J5ACKCFT.browser.mjs.map +1 -0
- package/build/js/chunk-JWPM3L3P.mjs +106 -0
- package/build/js/chunk-JWPM3L3P.mjs.map +1 -0
- package/build/js/chunk-K6FXKYXK.browser.mjs +26 -0
- package/build/js/chunk-K6FXKYXK.browser.mjs.map +1 -0
- package/build/js/chunk-KJEIKA3Z.mjs +31 -0
- package/build/js/chunk-KJEIKA3Z.mjs.map +1 -0
- package/build/js/chunk-NPGACSEZ.cjs +127 -0
- package/build/js/chunk-NPGACSEZ.cjs.map +1 -0
- package/build/js/chunk-Q34PQMAG.browser.mjs +31 -0
- package/build/js/chunk-Q34PQMAG.browser.mjs.map +1 -0
- package/build/js/chunk-QBUP4ZJ3.browser.mjs +26 -0
- package/build/js/chunk-QBUP4ZJ3.browser.mjs.map +1 -0
- package/build/js/chunk-R2RMUNCR.browser.mjs +9 -0
- package/build/js/chunk-R2RMUNCR.browser.mjs.map +1 -0
- package/build/js/chunk-SZDMUQWJ.browser.mjs +26 -0
- package/build/js/chunk-SZDMUQWJ.browser.mjs.map +1 -0
- package/build/js/chunk-UYZQH2FD.mjs +26 -0
- package/build/js/chunk-UYZQH2FD.mjs.map +1 -0
- package/build/js/chunk-YMSR5FTZ.cjs +31 -0
- package/build/js/chunk-YMSR5FTZ.cjs.map +1 -0
- package/build/js/chunk-ZSTKOCBT.mjs +9 -0
- package/build/js/chunk-ZSTKOCBT.mjs.map +1 -0
- package/build/js/index.browser.mjs +10 -0
- package/build/js/index.browser.mjs.map +1 -0
- package/build/js/index.cjs +43 -0
- package/build/js/index.cjs.map +1 -0
- package/build/js/index.mjs +10 -0
- package/build/js/index.mjs.map +1 -0
- package/build/js/public/Action.browser.mjs +4 -0
- package/build/js/public/Action.browser.mjs.map +1 -0
- package/build/js/public/Action.cjs +21 -0
- package/build/js/public/Action.cjs.map +1 -0
- package/build/js/public/Action.mjs +4 -0
- package/build/js/public/Action.mjs.map +1 -0
- package/build/js/public/ActionTypeV2.browser.mjs +4 -0
- package/build/js/public/ActionTypeV2.browser.mjs.map +1 -0
- package/build/js/public/ActionTypeV2.cjs +17 -0
- package/build/js/public/ActionTypeV2.cjs.map +1 -0
- package/build/js/public/ActionTypeV2.mjs +4 -0
- package/build/js/public/ActionTypeV2.mjs.map +1 -0
- package/build/js/public/ObjectTypeV2.browser.mjs +4 -0
- package/build/js/public/ObjectTypeV2.browser.mjs.map +1 -0
- package/build/js/public/ObjectTypeV2.cjs +25 -0
- package/build/js/public/ObjectTypeV2.cjs.map +1 -0
- package/build/js/public/ObjectTypeV2.mjs +4 -0
- package/build/js/public/ObjectTypeV2.mjs.map +1 -0
- package/build/js/public/OntologyObjectSet.browser.mjs +4 -0
- package/build/js/public/OntologyObjectSet.browser.mjs.map +1 -0
- package/build/js/public/OntologyObjectSet.cjs +25 -0
- package/build/js/public/OntologyObjectSet.cjs.map +1 -0
- package/build/js/public/OntologyObjectSet.mjs +4 -0
- package/build/js/public/OntologyObjectSet.mjs.map +1 -0
- package/build/js/public/OntologyObjectV2.browser.mjs +4 -0
- package/build/js/public/OntologyObjectV2.browser.mjs.map +1 -0
- package/build/js/public/OntologyObjectV2.cjs +85 -0
- package/build/js/public/OntologyObjectV2.cjs.map +1 -0
- package/build/js/public/OntologyObjectV2.mjs +4 -0
- package/build/js/public/OntologyObjectV2.mjs.map +1 -0
- package/build/js/public/OntologyV2.browser.mjs +4 -0
- package/build/js/public/OntologyV2.browser.mjs.map +1 -0
- package/build/js/public/OntologyV2.cjs +21 -0
- package/build/js/public/OntologyV2.cjs.map +1 -0
- package/build/js/public/OntologyV2.mjs +4 -0
- package/build/js/public/OntologyV2.mjs.map +1 -0
- package/build/js/public/QueryType.browser.mjs +4 -0
- package/build/js/public/QueryType.browser.mjs.map +1 -0
- package/build/js/public/QueryType.cjs +21 -0
- package/build/js/public/QueryType.cjs.map +1 -0
- package/build/js/public/QueryType.mjs +4 -0
- package/build/js/public/QueryType.mjs.map +1 -0
- package/build/types/_components.d.ts +4 -0
- package/build/types/_components.d.ts.map +1 -0
- package/build/types/index.d.ts +9 -0
- package/build/types/index.d.ts.map +1 -0
- package/build/types/public/Action.d.ts +71 -0
- package/build/types/public/Action.d.ts.map +1 -0
- package/build/types/public/ActionTypeV2.d.ts +30 -0
- package/build/types/public/ActionTypeV2.d.ts.map +1 -0
- package/build/types/public/ObjectTypeV2.d.ts +62 -0
- package/build/types/public/ObjectTypeV2.d.ts.map +1 -0
- package/build/types/public/OntologyObjectSet.d.ts +62 -0
- package/build/types/public/OntologyObjectSet.d.ts.map +1 -0
- package/build/types/public/OntologyObjectV2.d.ts +443 -0
- package/build/types/public/OntologyObjectV2.d.ts.map +1 -0
- package/build/types/public/OntologyV2.d.ts +28 -0
- package/build/types/public/OntologyV2.d.ts.map +1 -0
- package/build/types/public/QueryType.d.ts +50 -0
- package/build/types/public/QueryType.d.ts.map +1 -0
- package/package.json +66 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { ActionTypeApiName, ActionTypeV2, ListActionTypesResponseV2, OntologyIdentifier, PageSize, PageToken } from "@osdk/internal.foundry.core";
|
|
2
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
|
|
3
|
+
/**
|
|
4
|
+
* Lists the action types for the given Ontology.
|
|
5
|
+
*
|
|
6
|
+
* Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
|
|
7
|
+
* results available, at least one result will be present in the response.
|
|
8
|
+
*
|
|
9
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
10
|
+
*
|
|
11
|
+
* Required Scopes: [api:read-data]
|
|
12
|
+
* URL: /v2/ontologies/{ontology}/actionTypes
|
|
13
|
+
*/
|
|
14
|
+
export declare function listActionTypesV2($ctx: $Client | $ClientContext, ...args: [
|
|
15
|
+
ontology: OntologyIdentifier,
|
|
16
|
+
$queryParams?: {
|
|
17
|
+
pageSize?: PageSize | undefined;
|
|
18
|
+
pageToken?: PageToken | undefined;
|
|
19
|
+
}
|
|
20
|
+
]): Promise<ListActionTypesResponseV2>;
|
|
21
|
+
/**
|
|
22
|
+
* Gets a specific action type with the given API name.
|
|
23
|
+
*
|
|
24
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
25
|
+
*
|
|
26
|
+
* Required Scopes: [api:read-data]
|
|
27
|
+
* URL: /v2/ontologies/{ontology}/actionTypes/{actionType}
|
|
28
|
+
*/
|
|
29
|
+
export declare function getActionTypeV2($ctx: $Client | $ClientContext, ...args: [ontology: OntologyIdentifier, actionType: ActionTypeApiName]): Promise<ActionTypeV2>;
|
|
30
|
+
//# sourceMappingURL=ActionTypeV2.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ActionTypeV2.d.ts","sourceRoot":"","sources":["../../../src/public/ActionTypeV2.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,iBAAiB,EACjB,YAAY,EACZ,yBAAyB,EACzB,kBAAkB,EAClB,QAAQ,EACR,SAAS,EACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAe1B;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAE5B,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,yBAAyB,CAAC,CAEpC;AASD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,QAAQ,EAAE,kBAAkB,EAAE,UAAU,EAAE,iBAAiB,CAAC,GACrE,OAAO,CAAC,YAAY,CAAC,CAEvB"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { LinkTypeApiName, LinkTypeSideV2, ListObjectTypesV2Response, ListOutgoingLinkTypesResponseV2, ObjectTypeApiName, ObjectTypeV2, OntologyIdentifier, PageSize, PageToken } from "@osdk/internal.foundry.core";
|
|
2
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
|
|
3
|
+
/**
|
|
4
|
+
* Lists the object types for the given Ontology.
|
|
5
|
+
*
|
|
6
|
+
* Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are
|
|
7
|
+
* more results available, at least one result will be present in the
|
|
8
|
+
* response.
|
|
9
|
+
*
|
|
10
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
11
|
+
*
|
|
12
|
+
* Required Scopes: [api:read-data]
|
|
13
|
+
* URL: /v2/ontologies/{ontology}/objectTypes
|
|
14
|
+
*/
|
|
15
|
+
export declare function listObjectTypesV2($ctx: $Client | $ClientContext, ...args: [
|
|
16
|
+
ontology: OntologyIdentifier,
|
|
17
|
+
$queryParams?: {
|
|
18
|
+
pageSize?: PageSize | undefined;
|
|
19
|
+
pageToken?: PageToken | undefined;
|
|
20
|
+
}
|
|
21
|
+
]): Promise<ListObjectTypesV2Response>;
|
|
22
|
+
/**
|
|
23
|
+
* Gets a specific object type with the given API name.
|
|
24
|
+
*
|
|
25
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
26
|
+
*
|
|
27
|
+
* Required Scopes: [api:read-data]
|
|
28
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}
|
|
29
|
+
*/
|
|
30
|
+
export declare function getObjectTypeV2($ctx: $Client | $ClientContext, ...args: [ontology: OntologyIdentifier, objectType: ObjectTypeApiName]): Promise<ObjectTypeV2>;
|
|
31
|
+
/**
|
|
32
|
+
* List the outgoing links for an object type.
|
|
33
|
+
*
|
|
34
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
35
|
+
* following operation scopes: `api:read-data`.
|
|
36
|
+
*
|
|
37
|
+
* Required Scopes: [api:read-data]
|
|
38
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes
|
|
39
|
+
*/
|
|
40
|
+
export declare function listOutgoingLinkTypesV2($ctx: $Client | $ClientContext, ...args: [
|
|
41
|
+
ontology: OntologyIdentifier,
|
|
42
|
+
objectType: ObjectTypeApiName,
|
|
43
|
+
$queryParams?: {
|
|
44
|
+
pageSize?: PageSize | undefined;
|
|
45
|
+
pageToken?: PageToken | undefined;
|
|
46
|
+
}
|
|
47
|
+
]): Promise<ListOutgoingLinkTypesResponseV2>;
|
|
48
|
+
/**
|
|
49
|
+
* Get an outgoing link for an object type.
|
|
50
|
+
*
|
|
51
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
52
|
+
* following operation scopes: `api:read-data`.
|
|
53
|
+
*
|
|
54
|
+
* Required Scopes: [api:read-data]
|
|
55
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}
|
|
56
|
+
*/
|
|
57
|
+
export declare function getOutgoingLinkTypeV2($ctx: $Client | $ClientContext, ...args: [
|
|
58
|
+
ontology: OntologyIdentifier,
|
|
59
|
+
objectType: ObjectTypeApiName,
|
|
60
|
+
linkType: LinkTypeApiName
|
|
61
|
+
]): Promise<LinkTypeSideV2>;
|
|
62
|
+
//# sourceMappingURL=ObjectTypeV2.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ObjectTypeV2.d.ts","sourceRoot":"","sources":["../../../src/public/ObjectTypeV2.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,yBAAyB,EACzB,+BAA+B,EAC/B,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,SAAS,EACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAe1B;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAE5B,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,yBAAyB,CAAC,CAEpC;AASD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,QAAQ,EAAE,kBAAkB,EAAE,UAAU,EAAE,iBAAiB,CAAC,GACrE,OAAO,CAAC,YAAY,CAAC,CAEvB;AAaD;;;;;;;;GAQG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAE7B,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,+BAA+B,CAAC,CAE1C;AAUD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,QAAQ,EAAE,eAAe;CAC1B,GACA,OAAO,CAAC,cAAc,CAAC,CAEzB"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { AggregateObjectSetRequestV2, AggregateObjectsResponseV2, ArtifactRepositoryRid, CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetResponseV2, LoadObjectSetRequestV2, LoadObjectSetResponseV2, ObjectSet, ObjectSetRid, OntologyIdentifier, SdkPackageName } from "@osdk/internal.foundry.core";
|
|
2
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
|
|
3
|
+
/**
|
|
4
|
+
* Creates a temporary `ObjectSet` from the given definition.
|
|
5
|
+
*
|
|
6
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
7
|
+
* following operation scopes: `api:read-data api:write-data`.
|
|
8
|
+
*
|
|
9
|
+
* Required Scopes: [api:read-data, api:write-data]
|
|
10
|
+
* URL: /v2/ontologies/{ontology}/objectSets/createTemporary
|
|
11
|
+
*/
|
|
12
|
+
export declare function createTemporaryObjectSetV2($ctx: $Client | $ClientContext, ...args: [
|
|
13
|
+
ontology: OntologyIdentifier,
|
|
14
|
+
$body: CreateTemporaryObjectSetRequestV2
|
|
15
|
+
]): Promise<CreateTemporaryObjectSetResponseV2>;
|
|
16
|
+
/**
|
|
17
|
+
* Gets the definition of the `ObjectSet` with the given RID.
|
|
18
|
+
*
|
|
19
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
20
|
+
*
|
|
21
|
+
* Required Scopes: []
|
|
22
|
+
* URL: /v2/ontologies/{ontology}/objectSets/{objectSetRid}
|
|
23
|
+
*/
|
|
24
|
+
export declare function getObjectSetV2($ctx: $Client | $ClientContext, ...args: [ontology: OntologyIdentifier, objectSetRid: ObjectSetRid]): Promise<ObjectSet>;
|
|
25
|
+
/**
|
|
26
|
+
* Load the ontology objects present in the `ObjectSet` from the provided object set definition.
|
|
27
|
+
*
|
|
28
|
+
* 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
|
|
29
|
+
* 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.
|
|
30
|
+
*
|
|
31
|
+
* Note that null value properties will not be returned.
|
|
32
|
+
*
|
|
33
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
34
|
+
*
|
|
35
|
+
* Required Scopes: [api:read-data]
|
|
36
|
+
* URL: /v2/ontologies/{ontology}/objectSets/loadObjects
|
|
37
|
+
*/
|
|
38
|
+
export declare function loadObjectSetV2($ctx: $Client | $ClientContext, ...args: [
|
|
39
|
+
ontology: OntologyIdentifier,
|
|
40
|
+
$body: LoadObjectSetRequestV2,
|
|
41
|
+
$queryParams?: {
|
|
42
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
43
|
+
packageName?: SdkPackageName | undefined;
|
|
44
|
+
}
|
|
45
|
+
]): Promise<LoadObjectSetResponseV2>;
|
|
46
|
+
/**
|
|
47
|
+
* Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.
|
|
48
|
+
*
|
|
49
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
50
|
+
*
|
|
51
|
+
* Required Scopes: [api:read-data]
|
|
52
|
+
* URL: /v2/ontologies/{ontology}/objectSets/aggregate
|
|
53
|
+
*/
|
|
54
|
+
export declare function aggregateObjectSetV2($ctx: $Client | $ClientContext, ...args: [
|
|
55
|
+
ontology: OntologyIdentifier,
|
|
56
|
+
$body: AggregateObjectSetRequestV2,
|
|
57
|
+
$queryParams?: {
|
|
58
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
59
|
+
packageName?: SdkPackageName | undefined;
|
|
60
|
+
}
|
|
61
|
+
]): Promise<AggregateObjectsResponseV2>;
|
|
62
|
+
//# 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,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,iCAAiC,EACjC,kCAAkC,EAClC,sBAAsB,EACtB,uBAAuB,EACvB,SAAS,EACT,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACf,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAY1B;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,KAAK,EAAE,iCAAiC;CACzC,GACA,OAAO,CAAC,kCAAkC,CAAC,CAE7C;AASD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,YAAY,CAAC,GAClE,OAAO,CAAC,SAAS,CAAC,CAEpB;AAaD;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,KAAK,EAAE,sBAAsB;IAC7B,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,uBAAuB,CAAC,CAElC;AAaD;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,KAAK,EAAE,2BAA2B;IAClC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,0BAA0B,CAAC,CAErC"}
|
|
@@ -0,0 +1,443 @@
|
|
|
1
|
+
import type { AggregateObjectsRequestV2, AggregateObjectsResponseV2, ArtifactRepositoryRid, AttachmentMetadataResponse, AttachmentRid, AttachmentV2, CountObjectsResponseV2, InterfaceType, InterfaceTypeApiName, LinkTypeApiName, ListInterfaceTypesResponse, ListLinkedObjectsResponseV2, ListObjectsResponseV2, ObjectTypeApiName, ObjectTypeFullMetadata, OntologyIdentifier, OntologyObjectV2, OrderBy, PageSize, PageToken, PreviewMode, PropertyApiName, PropertyValueEscapedString, SdkPackageName, SearchObjectsForInterfaceRequest, SearchObjectsRequestV2, SearchObjectsResponseV2, SelectedPropertyApiName, StreamTimeSeriesPointsRequest, TimeSeriesPoint } from "@osdk/internal.foundry.core";
|
|
2
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
|
|
3
|
+
/**
|
|
4
|
+
* Lists the objects for the given Ontology and object type.
|
|
5
|
+
*
|
|
6
|
+
* Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or
|
|
7
|
+
* repeated objects in the response pages.
|
|
8
|
+
*
|
|
9
|
+
* 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
|
|
10
|
+
* 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.
|
|
11
|
+
*
|
|
12
|
+
* Each page may be smaller or larger than the requested page size. However, it
|
|
13
|
+
* is guaranteed that if there are more results available, at least one result will be present
|
|
14
|
+
* in the response.
|
|
15
|
+
*
|
|
16
|
+
* Note that null value properties will not be returned.
|
|
17
|
+
*
|
|
18
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
19
|
+
*
|
|
20
|
+
* Required Scopes: [api:read-data]
|
|
21
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}
|
|
22
|
+
*/
|
|
23
|
+
export declare function listObjectsV2($ctx: $Client | $ClientContext, ...args: [
|
|
24
|
+
ontology: OntologyIdentifier,
|
|
25
|
+
objectType: ObjectTypeApiName,
|
|
26
|
+
$queryParams: {
|
|
27
|
+
pageSize?: PageSize | undefined;
|
|
28
|
+
pageToken?: PageToken | undefined;
|
|
29
|
+
select: Array<SelectedPropertyApiName>;
|
|
30
|
+
orderBy?: OrderBy | undefined;
|
|
31
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
32
|
+
packageName?: SdkPackageName | undefined;
|
|
33
|
+
excludeRid?: boolean | undefined;
|
|
34
|
+
}
|
|
35
|
+
]): Promise<ListObjectsResponseV2>;
|
|
36
|
+
/**
|
|
37
|
+
* Gets a specific object with the given primary key.
|
|
38
|
+
*
|
|
39
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
40
|
+
*
|
|
41
|
+
* Required Scopes: [api:read-data]
|
|
42
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}
|
|
43
|
+
*/
|
|
44
|
+
export declare function getObjectV2($ctx: $Client | $ClientContext, ...args: [
|
|
45
|
+
ontology: OntologyIdentifier,
|
|
46
|
+
objectType: ObjectTypeApiName,
|
|
47
|
+
primaryKey: PropertyValueEscapedString,
|
|
48
|
+
$queryParams: {
|
|
49
|
+
select: Array<SelectedPropertyApiName>;
|
|
50
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
51
|
+
packageName?: SdkPackageName | undefined;
|
|
52
|
+
excludeRid?: boolean | undefined;
|
|
53
|
+
}
|
|
54
|
+
]): Promise<OntologyObjectV2>;
|
|
55
|
+
/**
|
|
56
|
+
* Returns a count of the objects of the given object type.
|
|
57
|
+
*
|
|
58
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
59
|
+
*
|
|
60
|
+
* Required Scopes: [api:read-data]
|
|
61
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/count
|
|
62
|
+
*/
|
|
63
|
+
export declare function countObjects($ctx: $Client | $ClientContext, ...args: [
|
|
64
|
+
ontology: OntologyIdentifier,
|
|
65
|
+
objectType: ObjectTypeApiName,
|
|
66
|
+
$queryParams?: {
|
|
67
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
68
|
+
packageName?: SdkPackageName | undefined;
|
|
69
|
+
}
|
|
70
|
+
]): Promise<CountObjectsResponseV2>;
|
|
71
|
+
/**
|
|
72
|
+
* Search for objects in the specified ontology and object type. The request body is used
|
|
73
|
+
* to filter objects based on the specified query. The supported queries are:
|
|
74
|
+
*
|
|
75
|
+
* | Query type | Description | Supported Types |
|
|
76
|
+
* |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
|
|
77
|
+
* | lt | The provided property is less than the provided value. | number, string, date, timestamp |
|
|
78
|
+
* | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
|
|
79
|
+
* | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
|
|
80
|
+
* | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
|
|
81
|
+
* | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
|
|
82
|
+
* | isNull | The provided property is (or is not) null. | all |
|
|
83
|
+
* | contains | The provided property contains the provided value. | array |
|
|
84
|
+
* | not | The sub-query does not match. | N/A (applied on a query) |
|
|
85
|
+
* | and | All the sub-queries match. | N/A (applied on queries) |
|
|
86
|
+
* | or | At least one of the sub-queries match. | N/A (applied on queries) |
|
|
87
|
+
* | startsWith | The provided property starts with the provided value. | string |
|
|
88
|
+
* | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
|
|
89
|
+
* | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |
|
|
90
|
+
* | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
|
|
91
|
+
* | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
|
|
92
|
+
*
|
|
93
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
94
|
+
*
|
|
95
|
+
* Required Scopes: [api:read-data]
|
|
96
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/search
|
|
97
|
+
*/
|
|
98
|
+
export declare function searchObjectsV2($ctx: $Client | $ClientContext, ...args: [
|
|
99
|
+
ontology: OntologyIdentifier,
|
|
100
|
+
objectType: ObjectTypeApiName,
|
|
101
|
+
$body: SearchObjectsRequestV2,
|
|
102
|
+
$queryParams?: {
|
|
103
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
104
|
+
packageName?: SdkPackageName | undefined;
|
|
105
|
+
}
|
|
106
|
+
]): Promise<SearchObjectsResponseV2>;
|
|
107
|
+
/**
|
|
108
|
+
* Perform functions on object fields in the specified ontology and object type.
|
|
109
|
+
*
|
|
110
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
111
|
+
*
|
|
112
|
+
* Required Scopes: [api:read-data]
|
|
113
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/aggregate
|
|
114
|
+
*/
|
|
115
|
+
export declare function aggregateObjectsV2($ctx: $Client | $ClientContext, ...args: [
|
|
116
|
+
ontology: OntologyIdentifier,
|
|
117
|
+
objectType: ObjectTypeApiName,
|
|
118
|
+
$body: AggregateObjectsRequestV2,
|
|
119
|
+
$queryParams?: {
|
|
120
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
121
|
+
packageName?: SdkPackageName | undefined;
|
|
122
|
+
}
|
|
123
|
+
]): Promise<AggregateObjectsResponseV2>;
|
|
124
|
+
/**
|
|
125
|
+
* :::callout{theme=warning title=Warning}
|
|
126
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
127
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
128
|
+
* :::
|
|
129
|
+
*
|
|
130
|
+
* Lists the interface types for the given Ontology.
|
|
131
|
+
*
|
|
132
|
+
* Each page may be smaller than the requested page size. However, it is guaranteed that if there are more
|
|
133
|
+
* results available, at least one result will be present in the response.
|
|
134
|
+
*
|
|
135
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
136
|
+
*
|
|
137
|
+
* Required Scopes: [api:read-data]
|
|
138
|
+
* URL: /v2/ontologies/{ontology}/interfaceTypes
|
|
139
|
+
*/
|
|
140
|
+
export declare function listInterfaceTypes($ctx: $Client | $ClientContext, ...args: [
|
|
141
|
+
ontology: OntologyIdentifier,
|
|
142
|
+
$queryParams?: {
|
|
143
|
+
pageSize?: PageSize | undefined;
|
|
144
|
+
pageToken?: PageToken | undefined;
|
|
145
|
+
preview?: PreviewMode | undefined;
|
|
146
|
+
}
|
|
147
|
+
]): Promise<ListInterfaceTypesResponse>;
|
|
148
|
+
/**
|
|
149
|
+
* :::callout{theme=warning title=Warning}
|
|
150
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
151
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
152
|
+
* :::
|
|
153
|
+
*
|
|
154
|
+
* Gets a specific object type with the given API name.
|
|
155
|
+
*
|
|
156
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
157
|
+
*
|
|
158
|
+
* Required Scopes: [api:read-data]
|
|
159
|
+
* URL: /v2/ontologies/{ontology}/interfaceTypes/{interfaceType}
|
|
160
|
+
*/
|
|
161
|
+
export declare function getInterfaceType($ctx: $Client | $ClientContext, ...args: [
|
|
162
|
+
ontology: OntologyIdentifier,
|
|
163
|
+
interfaceType: InterfaceTypeApiName,
|
|
164
|
+
$queryParams?: {
|
|
165
|
+
preview?: PreviewMode | undefined;
|
|
166
|
+
}
|
|
167
|
+
]): Promise<InterfaceType>;
|
|
168
|
+
/**
|
|
169
|
+
* :::callout{theme=warning title=Warning}
|
|
170
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
171
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
172
|
+
* :::
|
|
173
|
+
*
|
|
174
|
+
* Search for objects in the specified ontology and interface type. Any properties specified in the "where" or
|
|
175
|
+
* "orderBy" parameters must be shared property type API names defined on the interface. The following search
|
|
176
|
+
* queries are supported:
|
|
177
|
+
*
|
|
178
|
+
* | Query type | Description | Supported Types |
|
|
179
|
+
* |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|
|
|
180
|
+
* | lt | The provided property is less than the provided value. | number, string, date, timestamp |
|
|
181
|
+
* | gt | The provided property is greater than the provided value. | number, string, date, timestamp |
|
|
182
|
+
* | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |
|
|
183
|
+
* | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |
|
|
184
|
+
* | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |
|
|
185
|
+
* | isNull | The provided property is (or is not) null. | all |
|
|
186
|
+
* | contains | The provided property contains the provided value. | array |
|
|
187
|
+
* | not | The sub-query does not match. | N/A (applied on a query) |
|
|
188
|
+
* | and | All the sub-queries match. | N/A (applied on queries) |
|
|
189
|
+
* | or | At least one of the sub-queries match. | N/A (applied on queries) |
|
|
190
|
+
* | startsWith | The provided property starts with the provided value. | string |
|
|
191
|
+
* | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |
|
|
192
|
+
* | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |
|
|
193
|
+
* | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |
|
|
194
|
+
* | containsAllTerms | The provided property contains all the terms separated by whitespace. | string |
|
|
195
|
+
*
|
|
196
|
+
* Attempting to use an unsupported query will result in a validation error. Third-party applications using this
|
|
197
|
+
* endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
198
|
+
*
|
|
199
|
+
* Required Scopes: [api:read-data]
|
|
200
|
+
* URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/search
|
|
201
|
+
*/
|
|
202
|
+
export declare function searchObjectsForInterface($ctx: $Client | $ClientContext, ...args: [
|
|
203
|
+
ontology: OntologyIdentifier,
|
|
204
|
+
interfaceType: InterfaceTypeApiName,
|
|
205
|
+
$body: SearchObjectsForInterfaceRequest,
|
|
206
|
+
$queryParams?: {
|
|
207
|
+
preview?: PreviewMode | undefined;
|
|
208
|
+
}
|
|
209
|
+
]): Promise<SearchObjectsResponseV2>;
|
|
210
|
+
/**
|
|
211
|
+
* :::callout{theme=warning title=Warning}
|
|
212
|
+
* This endpoint is in preview and may be modified or removed at any time.
|
|
213
|
+
* To use this endpoint, add `preview=true` to the request query parameters.
|
|
214
|
+
* :::
|
|
215
|
+
*
|
|
216
|
+
* Perform functions on object fields in the specified ontology and of the specified interface type. Any
|
|
217
|
+
* properties specified in the query must be shared property type API names defined on the interface.
|
|
218
|
+
*
|
|
219
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
220
|
+
*
|
|
221
|
+
* Required Scopes: [api:read-data]
|
|
222
|
+
* URL: /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate
|
|
223
|
+
*/
|
|
224
|
+
export declare function aggregateObjectsForInterface($ctx: $Client | $ClientContext, ...args: [
|
|
225
|
+
ontology: OntologyIdentifier,
|
|
226
|
+
interfaceType: InterfaceTypeApiName,
|
|
227
|
+
$body: AggregateObjectsRequestV2,
|
|
228
|
+
$queryParams?: {
|
|
229
|
+
preview?: PreviewMode | undefined;
|
|
230
|
+
}
|
|
231
|
+
]): Promise<AggregateObjectsResponseV2>;
|
|
232
|
+
/**
|
|
233
|
+
* Lists the linked objects for a specific object and the given link type.
|
|
234
|
+
*
|
|
235
|
+
* Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or
|
|
236
|
+
* repeated objects in the response pages.
|
|
237
|
+
*
|
|
238
|
+
* 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
|
|
239
|
+
* 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.
|
|
240
|
+
*
|
|
241
|
+
* Each page may be smaller or larger than the requested page size. However, it
|
|
242
|
+
* is guaranteed that if there are more results available, at least one result will be present
|
|
243
|
+
* in the response.
|
|
244
|
+
*
|
|
245
|
+
* Note that null value properties will not be returned.
|
|
246
|
+
*
|
|
247
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
248
|
+
*
|
|
249
|
+
* Required Scopes: [api:read-data]
|
|
250
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}
|
|
251
|
+
*/
|
|
252
|
+
export declare function listLinkedObjectsV2($ctx: $Client | $ClientContext, ...args: [
|
|
253
|
+
ontology: OntologyIdentifier,
|
|
254
|
+
objectType: ObjectTypeApiName,
|
|
255
|
+
primaryKey: PropertyValueEscapedString,
|
|
256
|
+
linkType: LinkTypeApiName,
|
|
257
|
+
$queryParams: {
|
|
258
|
+
pageSize?: PageSize | undefined;
|
|
259
|
+
pageToken?: PageToken | undefined;
|
|
260
|
+
select: Array<SelectedPropertyApiName>;
|
|
261
|
+
orderBy?: OrderBy | undefined;
|
|
262
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
263
|
+
packageName?: SdkPackageName | undefined;
|
|
264
|
+
excludeRid?: boolean | undefined;
|
|
265
|
+
}
|
|
266
|
+
]): Promise<ListLinkedObjectsResponseV2>;
|
|
267
|
+
/**
|
|
268
|
+
* Get a specific linked object that originates from another object.
|
|
269
|
+
*
|
|
270
|
+
* If there is no link between the two objects, `LinkedObjectNotFound` is thrown.
|
|
271
|
+
*
|
|
272
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
273
|
+
*
|
|
274
|
+
* Required Scopes: [api:read-data]
|
|
275
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}
|
|
276
|
+
*/
|
|
277
|
+
export declare function getLinkedObjectV2($ctx: $Client | $ClientContext, ...args: [
|
|
278
|
+
ontology: OntologyIdentifier,
|
|
279
|
+
objectType: ObjectTypeApiName,
|
|
280
|
+
primaryKey: PropertyValueEscapedString,
|
|
281
|
+
linkType: LinkTypeApiName,
|
|
282
|
+
linkedObjectPrimaryKey: PropertyValueEscapedString,
|
|
283
|
+
$queryParams: {
|
|
284
|
+
select: Array<SelectedPropertyApiName>;
|
|
285
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
286
|
+
packageName?: SdkPackageName | undefined;
|
|
287
|
+
excludeRid?: boolean | undefined;
|
|
288
|
+
}
|
|
289
|
+
]): Promise<OntologyObjectV2>;
|
|
290
|
+
/**
|
|
291
|
+
* Get the metadata of attachments parented to the given object.
|
|
292
|
+
*
|
|
293
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
294
|
+
* following operation scopes: `api:read-data`.
|
|
295
|
+
*
|
|
296
|
+
* Required Scopes: [api:read-data]
|
|
297
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}
|
|
298
|
+
*/
|
|
299
|
+
export declare function getAttachmentsV2($ctx: $Client | $ClientContext, ...args: [
|
|
300
|
+
ontology: OntologyIdentifier,
|
|
301
|
+
objectType: ObjectTypeApiName,
|
|
302
|
+
primaryKey: PropertyValueEscapedString,
|
|
303
|
+
property: PropertyApiName,
|
|
304
|
+
$queryParams?: {
|
|
305
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
306
|
+
packageName?: SdkPackageName | undefined;
|
|
307
|
+
}
|
|
308
|
+
]): Promise<AttachmentMetadataResponse>;
|
|
309
|
+
/**
|
|
310
|
+
* Get the metadata of a particular attachment in an attachment list.
|
|
311
|
+
*
|
|
312
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
313
|
+
* following operation scopes: `api:read-data`.
|
|
314
|
+
*
|
|
315
|
+
* Required Scopes: [api:read-data]
|
|
316
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}
|
|
317
|
+
*/
|
|
318
|
+
export declare function getAttachmentByRidV2($ctx: $Client | $ClientContext, ...args: [
|
|
319
|
+
ontology: OntologyIdentifier,
|
|
320
|
+
objectType: ObjectTypeApiName,
|
|
321
|
+
primaryKey: PropertyValueEscapedString,
|
|
322
|
+
property: PropertyApiName,
|
|
323
|
+
attachmentRid: AttachmentRid,
|
|
324
|
+
$queryParams?: {
|
|
325
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
326
|
+
packageName?: SdkPackageName | undefined;
|
|
327
|
+
}
|
|
328
|
+
]): Promise<AttachmentV2>;
|
|
329
|
+
/**
|
|
330
|
+
* Get the content of an attachment.
|
|
331
|
+
*
|
|
332
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
333
|
+
* following operation scopes: `api:read-data`.
|
|
334
|
+
*
|
|
335
|
+
* Required Scopes: [api:read-data]
|
|
336
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content
|
|
337
|
+
*/
|
|
338
|
+
export declare function getAttachmentContentV2($ctx: $Client | $ClientContext, ...args: [
|
|
339
|
+
ontology: OntologyIdentifier,
|
|
340
|
+
objectType: ObjectTypeApiName,
|
|
341
|
+
primaryKey: PropertyValueEscapedString,
|
|
342
|
+
property: PropertyApiName,
|
|
343
|
+
$queryParams?: {
|
|
344
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
345
|
+
packageName?: SdkPackageName | undefined;
|
|
346
|
+
}
|
|
347
|
+
]): Promise<unknown>;
|
|
348
|
+
/**
|
|
349
|
+
* Get the content of an attachment by its RID.
|
|
350
|
+
*
|
|
351
|
+
* The RID must exist in the attachment array of the property.
|
|
352
|
+
*
|
|
353
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
354
|
+
* following operation scopes: `api:read-data`.
|
|
355
|
+
*
|
|
356
|
+
* Required Scopes: [api:read-data]
|
|
357
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content
|
|
358
|
+
*/
|
|
359
|
+
export declare function getAttachmentContentByRidV2($ctx: $Client | $ClientContext, ...args: [
|
|
360
|
+
ontology: OntologyIdentifier,
|
|
361
|
+
objectType: ObjectTypeApiName,
|
|
362
|
+
primaryKey: PropertyValueEscapedString,
|
|
363
|
+
property: PropertyApiName,
|
|
364
|
+
attachmentRid: AttachmentRid,
|
|
365
|
+
$queryParams?: {
|
|
366
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
367
|
+
packageName?: SdkPackageName | undefined;
|
|
368
|
+
}
|
|
369
|
+
]): Promise<unknown>;
|
|
370
|
+
/**
|
|
371
|
+
* Get the first point of a time series property.
|
|
372
|
+
*
|
|
373
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
374
|
+
* following operation scopes: `api:read-data`.
|
|
375
|
+
*
|
|
376
|
+
* Required Scopes: [api:read-data]
|
|
377
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint
|
|
378
|
+
*/
|
|
379
|
+
export declare function getFirstPoint($ctx: $Client | $ClientContext, ...args: [
|
|
380
|
+
ontology: OntologyIdentifier,
|
|
381
|
+
objectType: ObjectTypeApiName,
|
|
382
|
+
primaryKey: PropertyValueEscapedString,
|
|
383
|
+
property: PropertyApiName,
|
|
384
|
+
$queryParams?: {
|
|
385
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
386
|
+
packageName?: SdkPackageName | undefined;
|
|
387
|
+
}
|
|
388
|
+
]): Promise<TimeSeriesPoint | undefined>;
|
|
389
|
+
/**
|
|
390
|
+
* Get the last point of a time series property.
|
|
391
|
+
*
|
|
392
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
393
|
+
* following operation scopes: `api:read-data`.
|
|
394
|
+
*
|
|
395
|
+
* Required Scopes: [api:read-data]
|
|
396
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint
|
|
397
|
+
*/
|
|
398
|
+
export declare function getLastPoint($ctx: $Client | $ClientContext, ...args: [
|
|
399
|
+
ontology: OntologyIdentifier,
|
|
400
|
+
objectType: ObjectTypeApiName,
|
|
401
|
+
primaryKey: PropertyValueEscapedString,
|
|
402
|
+
property: PropertyApiName,
|
|
403
|
+
$queryParams?: {
|
|
404
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
405
|
+
packageName?: SdkPackageName | undefined;
|
|
406
|
+
}
|
|
407
|
+
]): Promise<TimeSeriesPoint | undefined>;
|
|
408
|
+
/**
|
|
409
|
+
* Stream all of the points of a time series property.
|
|
410
|
+
*
|
|
411
|
+
* Third-party applications using this endpoint via OAuth2 must request the
|
|
412
|
+
* following operation scopes: `api:read-data`.
|
|
413
|
+
*
|
|
414
|
+
* Required Scopes: [api:read-data]
|
|
415
|
+
* URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints
|
|
416
|
+
*/
|
|
417
|
+
export declare function streamPoints($ctx: $Client | $ClientContext, ...args: [
|
|
418
|
+
ontology: OntologyIdentifier,
|
|
419
|
+
objectType: ObjectTypeApiName,
|
|
420
|
+
primaryKey: PropertyValueEscapedString,
|
|
421
|
+
property: PropertyApiName,
|
|
422
|
+
$body: StreamTimeSeriesPointsRequest,
|
|
423
|
+
$queryParams?: {
|
|
424
|
+
artifactRepository?: ArtifactRepositoryRid | undefined;
|
|
425
|
+
packageName?: SdkPackageName | undefined;
|
|
426
|
+
}
|
|
427
|
+
]): Promise<unknown>;
|
|
428
|
+
/**
|
|
429
|
+
* Gets the full metadata for a specific object type with the given API name.
|
|
430
|
+
*
|
|
431
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
432
|
+
*
|
|
433
|
+
* Required Scopes: [api:read-data]
|
|
434
|
+
* URL: /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata
|
|
435
|
+
*/
|
|
436
|
+
export declare function getObjectTypeFullMetadata($ctx: $Client | $ClientContext, ...args: [
|
|
437
|
+
ontology: OntologyIdentifier,
|
|
438
|
+
objectType: ObjectTypeApiName,
|
|
439
|
+
$queryParams?: {
|
|
440
|
+
preview?: PreviewMode | undefined;
|
|
441
|
+
}
|
|
442
|
+
]): Promise<ObjectTypeFullMetadata>;
|
|
443
|
+
//# sourceMappingURL=OntologyObjectV2.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OntologyObjectV2.d.ts","sourceRoot":"","sources":["../../../src/public/OntologyObjectV2.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EACV,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,0BAA0B,EAC1B,aAAa,EACb,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,oBAAoB,EACpB,eAAe,EACf,0BAA0B,EAC1B,2BAA2B,EAC3B,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,kBAAkB,EAClB,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,SAAS,EACT,WAAW,EACX,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,gCAAgC,EAChC,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,6BAA6B,EAC7B,eAAe,EAChB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAEV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,kBAAkB,CAAC;AAqB1B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAE7B,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACvC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAC9B,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC;CACF,GACA,OAAO,CAAC,qBAAqB,CAAC,CAEhC;AAgBD;;;;;;;GAOG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IAEtC,YAAY,EAAE;QACZ,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACvC,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC;CACF,GACA,OAAO,CAAC,gBAAgB,CAAC,CAE3B;AAaD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAE7B,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,sBAAsB,CAAC,CAEjC;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,sBAAsB;IAC7B,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,uBAAuB,CAAC,CAElC;AAcD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,KAAK,EAAE,yBAAyB;IAChC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,0BAA0B,CAAC,CAErC;AAaD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAE5B,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,0BAA0B,CAAC,CAErC;AAUD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,aAAa,EAAE,oBAAoB;IAEnC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,aAAa,CAAC,CAExB;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,aAAa,EAAE,oBAAoB;IACnC,KAAK,EAAE,gCAAgC;IACvC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,uBAAuB,CAAC,CAElC;AAWD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,aAAa,EAAE,oBAAoB;IACnC,KAAK,EAAE,yBAAyB;IAChC,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,0BAA0B,CAAC,CAErC;AAoBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IAEzB,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACvC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAC9B,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC;CACF,GACA,OAAO,CAAC,2BAA2B,CAAC,CAEtC;AAkBD;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IACzB,sBAAsB,EAAE,0BAA0B;IAElD,YAAY,EAAE;QACZ,MAAM,EAAE,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACvC,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACzC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAClC;CACF,GACA,OAAO,CAAC,gBAAgB,CAAC,CAE3B;AAeD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IAEzB,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,0BAA0B,CAAC,CAErC;AAgBD;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IACzB,aAAa,EAAE,aAAa;IAE5B,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,YAAY,CAAC,CAEvB;AAqBD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IAEzB,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,OAAO,CAAC,CAElB;AAsBD;;;;;;;;;;GAUG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IACzB,aAAa,EAAE,aAAa;IAE5B,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,OAAO,CAAC,CAElB;AAeD;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IAEzB,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAEtC;AAeD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IAEzB,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAEtC;AAsBD;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAC7B,UAAU,EAAE,0BAA0B;IACtC,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,6BAA6B;IACpC,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;QACvD,WAAW,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;KAC1C;CACF,GACA,OAAO,CAAC,OAAO,CAAC,CAElB;AAUD;;;;;;;GAOG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,QAAQ,EAAE,kBAAkB;IAC5B,UAAU,EAAE,iBAAiB;IAE7B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,sBAAsB,CAAC,CAEjC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { ListOntologiesV2Response, OntologyFullMetadata, OntologyIdentifier, OntologyV2 } from "@osdk/internal.foundry.core";
|
|
2
|
+
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.net";
|
|
3
|
+
/**
|
|
4
|
+
* Lists the Ontologies visible to the current user.
|
|
5
|
+
*
|
|
6
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
7
|
+
*
|
|
8
|
+
* Required Scopes: [api:read-data]
|
|
9
|
+
* URL: /v2/ontologies
|
|
10
|
+
*/
|
|
11
|
+
export declare function listOntologiesV2($ctx: $Client | $ClientContext, ...args: []): Promise<ListOntologiesV2Response>;
|
|
12
|
+
/**
|
|
13
|
+
* Gets a specific ontology with the given Ontology RID.
|
|
14
|
+
*
|
|
15
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:read-data`.
|
|
16
|
+
*
|
|
17
|
+
* Required Scopes: [api:read-data]
|
|
18
|
+
* URL: /v2/ontologies/{ontology}
|
|
19
|
+
*/
|
|
20
|
+
export declare function getOntologyV2($ctx: $Client | $ClientContext, ...args: [ontology: OntologyIdentifier]): Promise<OntologyV2>;
|
|
21
|
+
/**
|
|
22
|
+
* Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces.
|
|
23
|
+
*
|
|
24
|
+
* Required Scopes: [api:read-data]
|
|
25
|
+
* URL: /v2/ontologies/{ontology}/fullMetadata
|
|
26
|
+
*/
|
|
27
|
+
export declare function getOntologyFullMetadata($ctx: $Client | $ClientContext, ...args: [ontology: OntologyIdentifier]): Promise<OntologyFullMetadata>;
|
|
28
|
+
//# sourceMappingURL=OntologyV2.d.ts.map
|