diff --git a/.changeset/regenerate-sdk-1.1763.0-1787822057399.md b/.changeset/regenerate-sdk-1.1763.0-1787822057399.md new file mode 100644 index 000000000..567856099 --- /dev/null +++ b/.changeset/regenerate-sdk-1.1763.0-1787822057399.md @@ -0,0 +1,41 @@ +--- +"@osdk/docs-spec-platform": patch +"@osdk/foundry": patch +"@osdk/foundry.admin": patch +"@osdk/foundry.aipagents": patch +"@osdk/foundry.audit": patch +"@osdk/foundry.checkpoints": patch +"@osdk/foundry.connectivity": patch +"@osdk/foundry.core": patch +"@osdk/foundry.datahealth": patch +"@osdk/foundry.datasets": patch +"@osdk/foundry.filesystem": patch +"@osdk/foundry.functions": patch +"@osdk/foundry.geo": patch +"@osdk/foundry.languagemodels": patch +"@osdk/foundry.mediasets": patch +"@osdk/foundry.models": patch +"@osdk/foundry.notepad": patch +"@osdk/foundry.ontologies": patch +"@osdk/foundry.operations": patch +"@osdk/foundry.orchestration": patch +"@osdk/foundry.pack": patch +"@osdk/foundry.publicapis": patch +"@osdk/foundry.sqlqueries": patch +"@osdk/foundry.streams": patch +"@osdk/foundry.thirdpartyapplications": patch +"@osdk/foundry.widgets": patch +"@osdk/gotham": patch +"@osdk/gotham.core": patch +"@osdk/gotham.gaia": patch +"@osdk/gotham.geojson": patch +"@osdk/gotham.maprendering": patch +"@osdk/gotham.targetworkbench": patch +"@osdk/internal.foundry": patch +"@osdk/internal.foundry.core": patch +"@osdk/internal.foundry.datasets": patch +"@osdk/internal.foundry.geo": patch +"@osdk/internal.foundry.ontologies": patch +--- + +Regenerate SDKs with API version 1.1763.0 diff --git a/packages/docs-spec-platform/package.json b/packages/docs-spec-platform/package.json index b7bca3559..96d4b7a25 100644 --- a/packages/docs-spec-platform/package.json +++ b/packages/docs-spec-platform/package.json @@ -50,7 +50,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/docs-spec-platform/src/generated/namespaces/MediaSetsV2.ts b/packages/docs-spec-platform/src/generated/namespaces/MediaSetsV2.ts index 74a3d0860..c9ae98d80 100644 --- a/packages/docs-spec-platform/src/generated/namespaces/MediaSetsV2.ts +++ b/packages/docs-spec-platform/src/generated/namespaces/MediaSetsV2.ts @@ -17,4 +17,4 @@ import type { Namespace } from "../../ir/Namespace.js"; // dprint-ignore -export const MediaSetsV2: Namespace = {"name":"MediaSets","version":"v2","outputAuditVersions":"V3_ONLY","resources":[{"singleton":false,"documentation":{"description":"A media set is a representation of media data in Foundry. For more information, refer to the [media sets](/docs/foundry/data-integration/media-sets/) user documentation.\n","example":[]},"component":{"namespaceName":"MediaSets","localName":"MediaSet"},"pluralName":"MediaSets","operations":[{"name":"abortMediaTransaction","verb":"abort","documentation":{"description":"Aborts an open transaction. Items uploaded to the media set during this transaction will be deleted.\n","plainTextDescription":"Aborts an open transaction. Items uploaded to the media set during this transaction will be deleted.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/transactions/{transactionId}/abort","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"calculateImageMediaItemThumbnail","verb":"calculate","documentation":{"description":"Starts calculation of a thumbnail for a given image.\n","plainTextDescription":"Starts calculation of a thumbnail for a given image.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform/imagery/thumbnail/calculate","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Status of the thumbnail calculation. Type will be 'successful' if the thumbnail is available, \n'pending' if the thumbnail is being calculated, and 'failed' if there was an error.\n","plainTextDescription":"Status of the thumbnail calculation. Type will be 'successful' if the thumbnail is available,\n'pending' if the thumbnail is being calculated, and 'failed' if there was an error.","example":[{"type":"successful"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"clearMediaItemAtPath","verb":"clear","documentation":{"description":"Clears (soft-deletes) the media item at the specified path within a media set, making it and all older\nmedia items at that path un-retrievable.\n\nA branch name, branch RID, or view RID may optionally be specified. If none is specified,\nthe item will be cleared from the default branch. If more than one is specified, an error is thrown.\n\nFor transactional media sets, a transaction ID must be provided. The deletion will not be\nvisible until the transaction is committed.\n","plainTextDescription":"Clears (soft-deletes) the media item at the specified path within a media set, making it and all older\nmedia items at that path un-retrievable.\nA branch name, branch RID, or view RID may optionally be specified. If none is specified,\nthe item will be cleared from the default branch. If more than one is specified, an error is thrown.\nFor transactional media sets, a transaction ID must be provided. The deletion will not be\nvisible until the transaction is committed.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataDelete"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/clearAtPath","httpMethod":"DELETE","parameters":[{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"The path of the media item to clear.\n","plainTextDescription":"The path of the media item to clear.","example":["q3-data%2fmy-file.png"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided.","plainTextDescription":"Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchRid","documentation":{"description":"Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided.","plainTextDescription":"Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided.","plainTextDescription":"Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of the transaction associated with this request. Required if this is a transactional media set.\n","plainTextDescription":"The ID of the transaction associated with this request. Required if this is a transactional media set.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Media item cleared successfully.","plainTextDescription":"Media item cleared successfully.","example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"commitMediaTransaction","verb":"commit","documentation":{"description":"Commits an open transaction. On success, items uploaded to the media set during this transaction will become available.\n","plainTextDescription":"Commits an open transaction. On success, items uploaded to the media set during this transaction will become available.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/transactions/{transactionId}/commit","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"createMediaTransaction","verb":"create","documentation":{"description":"Creates a new transaction. Items uploaded to the media set while this transaction is open will not be reflected until the transaction is committed.\n","plainTextDescription":"Creates a new transaction. Items uploaded to the media set while this transaction is open will not be reflected until the transaction is committed.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/transactions","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"The branch on which to open the transaction. Defaults to `master` for most enrollments.\n","plainTextDescription":"The branch on which to open the transaction. Defaults to master for most enrollments.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"transactionId":"550e8400-e29b-41d4-a716-446655440000"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemInfo","verb":"info","documentation":{"description":"Gets information about the media item.\n","plainTextDescription":"Gets information about the media item.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"viewRid":"ri.mio.main.view.1","logicalTimestamp":12345,"path":"example.png","attribution":{"creatorId":1,"creationTimestamp":"2020-07-10 15:00:00.000"},"originallyUploadedFileMimeType":"image/png"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemInfoResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemMetadata","verb":"metadata","documentation":{"description":"Gets detailed metadata about the media item, including type-specific information\nsuch as dimensions for images, duration for audio/video, page count for documents, etc.\n","plainTextDescription":"Gets detailed metadata about the media item, including type-specific information\nsuch as dimensions for images, duration for audio/video, page count for documents, etc.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"type":"imagery","format":"PNG","dimensions":{"width":1920,"height":1080},"sizeBytes":2048576}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaItemMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemReference","verb":"reference","documentation":{"description":"Gets the [media reference](/docs/foundry/data-integration/media-sets/#media-references) for this media item.\n","plainTextDescription":"Gets the media reference for this media item.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReference"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemRidByPath","verb":"getRidByPath","documentation":{"description":"Returns the media item RID for the media item with the specified path.\n","plainTextDescription":"Returns the media item RID for the media item with the specified path.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/getRidByPath","httpMethod":"GET","parameters":[{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"The path of the media item.\n","plainTextDescription":"The path of the media item.","example":[]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name in which to search for this media item. May not be provided if branch rid or view rid are provided.","plainTextDescription":"Specifies the specific branch by name in which to search for this media item. May not be provided if branch rid or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchRid","documentation":{"description":"Specifies the specific branch by rid in which to search for this media item. May not be provided if branch name or view rid are provided.","plainTextDescription":"Specifies the specific branch by rid in which to search for this media item. May not be provided if branch name or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid in which to search for this media item. May not be provided if branch name or branch rid are provided.","plainTextDescription":"Specifies the specific view by rid in which to search for this media item. May not be provided if branch name or branch rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemRidByPathResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaSet","verb":"get","documentation":{"description":"Gets information about the media set.\n","plainTextDescription":"Gets information about the media set.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}","httpMethod":"GET","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetMediaSetResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getTransformationJobResult","verb":"getResult","documentation":{"description":"Gets the result of a completed transformation job. Returns the transformed media content as binary data.\nThis endpoint will return an error if the transformation job has not completed successfully.\n","plainTextDescription":"Gets the result of a completed transformation job. Returns the transformed media content as binary data.\nThis endpoint will return an error if the transformation job has not completed successfully.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-transform"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}/result","httpMethod":"GET","parameters":[{"name":"Token","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transformationJobId","documentation":{"description":"The ID of the transformation job.\n","plainTextDescription":"The ID of the transformation job.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The transformed media content.","plainTextDescription":"The transformed media content.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getTransformationJobStatus","verb":"getStatus","documentation":{"description":"Gets the status of a transformation job.\n","plainTextDescription":"Gets the status of a transformation job.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-transform"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}","httpMethod":"GET","parameters":[{"name":"Token","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transformationJobId","documentation":{"description":"The ID of the transformation job.\n","plainTextDescription":"The ID of the transformation job.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The status of the transformation job.","plainTextDescription":"The status of the transformation job.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetTransformationJobStatusResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"putMediaItem","verb":"upload","documentation":{"description":"Uploads a media item to an existing media set.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\nA branch name, or branch rid, or view rid may optionally be specified. If none is specified, the item will be uploaded to the default branch. If more than one is specified, an error is thrown.\n","plainTextDescription":"Uploads a media item to an existing media set.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.\nA branch name, or branch rid, or view rid may optionally be specified. If none is specified, the item will be uploaded to the default branch. If more than one is specified, an error is thrown.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"An identifier for a media item within a media set. Necessary if the backing media set requires paths.","plainTextDescription":"An identifier for a media item within a media set. Necessary if the backing media set requires paths.","example":["q3-data%2fmy-file.png"]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name to which this media item will be uploaded. May not be provided if branch rid or view rid are provided.","plainTextDescription":"Specifies the specific branch by name to which this media item will be uploaded. May not be provided if branch rid or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchRid","documentation":{"description":"Specifies the specific branch by rid to which this media item will be uploaded. May not be provided if branch name or view rid are provided.","plainTextDescription":"Specifies the specific branch by rid to which this media item will be uploaded. May not be provided if branch name or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.","plainTextDescription":"Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The id of the transaction associated with this request. Required if this is a transactional media set.\n","plainTextDescription":"The id of the transaction associated with this request. Required if this is a transactional media set.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of `ri.mio..media-item.`, where `` is the same as \nthe instance part of the media set RID, and `` is a UUID.\nAn `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format.\nA `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\n","plainTextDescription":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of ri.mio..media-item., where is the same as\nthe instance part of the media set RID, and is a UUID.\nAn InvalidMediaItemRid error will be thrown if the RID is not in the expected format.\nA MediaItemRidAlreadyExists error will be thrown if the media set already contains a media item with the same RID.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PutMediaItemResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"readMediaItem","verb":"read","documentation":{"description":"Gets the content of a media item.\n","plainTextDescription":"Gets the content of a media item.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The content stream.","plainTextDescription":"The content stream.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"readOriginalMediaItem","verb":"readOriginal","documentation":{"description":"Gets the content of an original file uploaded to the media item, even if it was transformed on upload due to being an additional input format.\n","plainTextDescription":"Gets the content of an original file uploaded to the media item, even if it was transformed on upload due to being an additional input format.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The content stream.","plainTextDescription":"The content stream.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"registerMediaItem","verb":"register","documentation":{"description":"Registers a media item that currently resides in a federated media store. Registration will validate the item\nagainst the media set's schema and perform initial metadata extraction.\nThis endpoint is only applicable for federated media sets.\n","plainTextDescription":"Registers a media item that currently resides in a federated media store. Registration will validate the item\nagainst the media set's schema and perform initial metadata extraction.\nThis endpoint is only applicable for federated media sets.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/register","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name to which this media item will be registered.","plainTextDescription":"Specifies the specific branch by name to which this media item will be registered.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid to which this media item will be registered.","plainTextDescription":"Specifies the specific view by rid to which this media item will be registered.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The id of the transaction associated with this request. Required for transactional media sets.","plainTextDescription":"The id of the transaction associated with this request. Required for transactional media sets.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"retrieveImageMediaItemThumbnail","verb":"retrieve","documentation":{"description":"Retrieves a successfully calculated thumbnail for a given image.\n\nThumbnails are 200px wide in the format of `image/webp`\n","plainTextDescription":"Retrieves a successfully calculated thumbnail for a given image.\nThumbnails are 200px wide in the format of image/webp","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform/imagery/thumbnail/retrieve","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Retrieves the thumbnail of an image (if available).\n","plainTextDescription":"Retrieves the thumbnail of an image (if available).","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"transformMediaItem","verb":"transform","documentation":{"description":"Initiates a transformation on a media item. Returns a job ID that can be used to check the status and retrieve \nthe result of the transformation.\n\nTransforming a media item requires that you are able to read the media item, either via `api:mediasets-read` or\nvia a `MediaItemReadToken`\n","plainTextDescription":"Initiates a transformation on a media item. Returns a job ID that can be used to check the status and retrieve\nthe result of the transformation.\nTransforming a media item requires that you are able to read the media item, either via api:mediasets-read or\nvia a MediaItemReadToken","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-transform"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform","httpMethod":"POST","parameters":[{"name":"Token","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"Attribution","documentation":{"description":"Optional resource to attribute LLM calls on behalf of.","plainTextDescription":"Optional resource to attribute LLM calls on behalf of.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"transformation":{"type":"image","encoding":{"type":"webp"},"operations":[{"type":"resize","width":800,"height":600}]}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"The transformation was initiated successfully.","plainTextDescription":"The transformation was initiated successfully.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"uploadMedia","verb":"uploadMedia","documentation":{"description":"Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted. \n\nIf multiple resources are attributed to, usage will be attributed to the first one in the list.\n\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\nThird-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`.\n","plainTextDescription":"Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted.\nIf multiple resources are attributed to, usage will be attributed to the first one in the list.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.\nThird-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-write.","example":[]},"releaseStage":"STABLE","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/media/upload","httpMethod":"PUT","parameters":[{"name":"attribution","documentation":{"description":"used for passing through usage attribution","plainTextDescription":"used for passing through usage attribution","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"A user-defined label for a media item within a media set. Required if the backing media set requires paths. \nUploading multiple files to the same path will result in only the most recent file being associated with the \npath.\n","plainTextDescription":"A user-defined label for a media item within a media set. Required if the backing media set requires paths.\nUploading multiple files to the same path will result in only the most recent file being associated with the\npath.","example":["my-file.png"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of `ri.mio..media-item.`, where `` is the same as \nthe instance part of the media set RID, and `` is a UUID.\nAn `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format.\nA `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\n","plainTextDescription":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of ri.mio..media-item., where is the same as\nthe instance part of the media set RID, and is a UUID.\nAn InvalidMediaItemRid error will be thrown if the RID is not in the expected format.\nA MediaItemRidAlreadyExists error will be thrown if the media set already contains a media item with the same RID.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"The media reference for the uploaded media.","plainTextDescription":"The media reference for the uploaded media.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReference"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]}],"components":[{"locator":{"namespaceName":"MediaSets","localName":"MediaAttribution"},"type":{"type":"object","object":{"properties":{"creatorId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"example":[]}},"creationTimestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"The timestamp when the media item was created, in ISO 8601 timestamp format.","plainTextDescription":"The timestamp when the media item was created, in ISO 8601 timestamp format.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"getEmailBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetEmailBodyOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for email to text extraction.","plainTextDescription":"The operation to perform for email to text extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractSceneFrames":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractSceneFramesOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to archive conversion.","plainTextDescription":"The operation to perform for video to archive conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BranchName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and \n(c) not a valid ResourceIdentifier.\n","plainTextDescription":"A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and\n(c) not a valid ResourceIdentifier.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Orientation"},"type":{"type":"object","object":{"properties":{"rotationAngle":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RotationAngle"}}}}},"safety":"SAFE","documentation":{"example":[]}},"flipAxis":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"FlipAxis"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The orientation information as encoded in EXIF metadata.","plainTextDescription":"The orientation information as encoded in EXIF metadata.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts text content from email.","plainTextDescription":"Extracts text content from email.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetEmailAttachmentOperation"},"type":{"type":"object","object":{"properties":{"mimeType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The MIME type of the attachment. Must match the metadata attachment MIME type.\n","plainTextDescription":"The MIME type of the attachment. Must match the metadata attachment MIME type.","example":[]}},"attachmentIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The attachment index.","plainTextDescription":"The attachment index.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Retrieves the bytes of an email attachment by index.","plainTextDescription":"Retrieves the bytes of an email attachment by index.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"WavEncodeFormat"},"type":{"type":"object","object":{"properties":{"sampleRate":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The sample rate in Hz. Defaults to 44100 Hz if not specified.","plainTextDescription":"The sample rate in Hz. Defaults to 44100 Hz if not specified.","example":[]}},"audioChannelLayout":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelLayout"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"WAV audio format with optional sample rate and channel layout.","plainTextDescription":"WAV audio format with optional sample rate and channel layout.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextFromPagesToArrayOperation"},"type":{"type":"object","object":{"properties":{"startPage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed start page. Defaults to the first page if not specified.","plainTextDescription":"The zero-indexed start page. Defaults to the first page if not specified.","example":[]}},"endPage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed end page (inclusive). Defaults to the last page if not specified.","plainTextDescription":"The zero-indexed end page (inclusive). Defaults to the last page if not specified.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts text from multiple pages into a list of strings.","plainTextDescription":"Extracts text from multiple pages into a list of strings.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationSuccessfulResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"WebpFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"WebP image format.","plainTextDescription":"WebP image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"NumberOfChannels"},"type":{"type":"object","object":{"properties":{"numberOfChannels":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The number of audio channels.","plainTextDescription":"The number of audio channels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specifies the number of audio channels. Defaults to 2 (stereo).","plainTextDescription":"Specifies the number of audio channels. Defaults to 2 (stereo).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextPreprocessingWrapper"},"type":{"type":"object","object":{"properties":{"extractText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for text extraction preprocessing.","plainTextDescription":"Wrapper for text extraction preprocessing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CreatePdfOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Converts an image to a PDF document.","plainTextDescription":"Converts an image to a PDF document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageExtractLayoutAwareContentOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionParameters"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts text from an image with layout information preserved.","plainTextDescription":"Extracts text from an image with layout information preserved.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomDataElementKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The key of a DICOM data element.","plainTextDescription":"The key of a DICOM data element.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Model3dType"},"type":{"type":"enum","enum":{"values":["POINT_CLOUD","MESH"]}},"safety":"SAFE","documentation":{"description":"The type of 3D model representation.","plainTextDescription":"The type of 3D model representation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms audio media items.","plainTextDescription":"Transforms audio media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AnnotateImageOperation"},"type":{"type":"object","object":{"properties":{"annotations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Annotation"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of annotations to draw on the image.","plainTextDescription":"The list of annotations to draw on the image.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Annotates an image with bounding boxes, labels, and colors.","plainTextDescription":"Annotates an image with bounding boxes, labels, and colors.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LanguageModelLocator"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ApiNameLocatorWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Locator for identifying a language model.","plainTextDescription":"Locator for identifying a language model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"slicePdfRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SlicePdfRangeOperation"}}}},"convertDocument":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ConvertDocumentOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for document to document conversion.","plainTextDescription":"The operation to perform for document to document conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSchema"},"type":{"type":"enum","enum":{"values":["AUDIO","CAD","DICOM","DOCUMENT","IMAGERY","MODEL_3D","MULTIMODAL","SPREADSHEET","STREAMING_VIDEO","VIDEO","EMAIL"]}},"safety":"SAFE","documentation":{"description":"The schema type of a media set, indicating what type of media items it can contain.","plainTextDescription":"The schema type of a media set, indicating what type of media items it can contain.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageOperation"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of operations to apply to the image, in order.","plainTextDescription":"The list of operations to apply to the image, in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms images with multiple operations applied in sequence.\nOperations are applied in the order they appear in the list.\n","plainTextDescription":"Transforms images with multiple operations applied in sequence.\nOperations are applied in the order they appear in the list.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailAttachment"},"type":{"type":"object","object":{"properties":{"attachmentIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The index of the attachment in the email.","plainTextDescription":"The index of the attachment in the email.","example":[]}},"fileName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The file name of the attachment, if available.","plainTextDescription":"The file name of the attachment, if available.","example":[]}},"mimeType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The verified MIME type of the attachment.","plainTextDescription":"The verified MIME type of the attachment.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an email attachment.","plainTextDescription":"Metadata about an email attachment.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransactionPolicy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"batchTransactions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BatchTransactionsTransactionPolicy"}}}},"noTransactions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"NoTransactionsTransactionPolicy"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The transaction policy for a media set, determining how writes are handled.\n","plainTextDescription":"The transaction policy for a media set, determining how writes are handled.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VlmOutputFormat"},"type":{"type":"enum","enum":{"values":["MARKDOWN"]}},"safety":"SAFE","documentation":{"description":"Format in which to return text extracted by vision language models.","plainTextDescription":"Format in which to return text extracted by vision language models.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Pttml"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"PTTML (Palantir Timed Text Markup Language) transcription output format.","plainTextDescription":"PTTML (Palantir Timed Text Markup Language) transcription output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RenderImageLayerOperation"},"type":{"type":"object","object":{"properties":{"layerNumber":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The layer number to render. If not specified, renders the middle layer.\n","plainTextDescription":"The layer number to render. If not specified, renders the middle layer.","example":[]}},"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Renders a frame of a DICOM file as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Renders a frame of a DICOM file as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractTableOfContentsOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts the table of contents from a document.","plainTextDescription":"Extracts the table of contents from a document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UnitInterpretation"},"type":{"type":"object","object":{"properties":{"unit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"scale":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"offset":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The unit interpretation for a band.","plainTextDescription":"The unit interpretation for a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"equalize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastEqualize"}}}},"rayleigh":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastRayleigh"}}}},"binarize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastBinarize"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The type of contrast adjustment to apply.","plainTextDescription":"The type of contrast adjustment to apply.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractTableOfContents":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractTableOfContentsOperation"}}}},"getPdfPageDimensions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetPdfPageDimensionsOperation"}}}},"extractAllText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractAllTextOperation"}}}},"extractVlmText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractVlmTextOperation"}}}},"extractTextFromPagesToArray":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextFromPagesToArrayOperation"}}}},"ocrOnPage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPageOperation"}}}},"extractFormFields":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractFormFieldsOperation"}}}},"extractLayoutAwareTextV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Operation"}}}},"extractTextV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Operation"}}}},"extractUnstructuredTextFromPage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractUnstructuredTextFromPageOperation"}}}},"extractLayoutAwareContent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentExtractLayoutAwareContentOperation"}}}},"ocrOnPages":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPagesOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for document to text conversion.","plainTextDescription":"The operation to perform for document to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageRegionPolygon"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImagePixelCoordinate"}}}}},"safety":"SAFE","documentation":{"description":"Polygon drawn by connecting adjacent coordinates in the list with straight lines.\nA line is drawn between the last and first coordinates in the list to create a closed shape.\nUsed to define regions in an image for operations like encryption/decryption.\n","plainTextDescription":"Polygon drawn by connecting adjacent coordinates in the list with straight lines.\nA line is drawn between the last and first coordinates in the list to create a closed shape.\nUsed to define regions in an image for operations like encryption/decryption.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrOutputFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"hocr":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrHocrOutputFormat"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrTextOutputFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for OCR results.","plainTextDescription":"The output format for OCR results.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GroupWrapper"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Group"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A wrapper for a group in the MailboxOrGroup union.","plainTextDescription":"A wrapper for a group in the MailboxOrGroup union.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextEncodeFormat"},"type":{"type":"enum","enum":{"values":["TEXT","HTML"]}},"safety":"SAFE","documentation":{"description":"The output format for email body extraction.","plainTextDescription":"The output format for email body extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An identifier for a media item transformation job.\n","plainTextDescription":"An identifier for a media item transformation job.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GroundControlPoint"},"type":{"type":"object","object":{"properties":{"pixX":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The pixel X coordinate.","plainTextDescription":"The pixel X coordinate.","example":[]}},"pixY":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The pixel Y coordinate.","plainTextDescription":"The pixel Y coordinate.","example":[]}},"projX":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The projected X coordinate.","plainTextDescription":"The projected X coordinate.","example":[]}},"projY":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The projected Y coordinate.","plainTextDescription":"The projected Y coordinate.","example":[]}},"projZ":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The projected Z coordinate.","plainTextDescription":"The projected Z coordinate.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A ground control point for geo-referencing.","plainTextDescription":"A ground control point for geo-referencing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"pending":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationPendingResponse"}}}},"failed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationFailedResponse"}}}},"successful":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationSuccessfulResponse"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetPdfPageDimensionsOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the dimensions of each page in a PDF document as JSON (in points).","plainTextDescription":"Returns the dimensions of each page in a PDF document as JSON (in points).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractFirstFrameOperation"},"type":{"type":"object","object":{"properties":{"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts the first full scene frame from the video.\nIf both width and height are not specified, preserves the original size.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Extracts the first full scene frame from the video.\nIf both width and height are not specified, preserves the original size.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationFailedResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConvertAudioOperation"},"type":{"type":"object","object":{"properties":{"encodeFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts audio to the specified format.","plainTextDescription":"Converts audio to the specified format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoDecodeFormat"},"type":{"type":"enum","enum":{"values":["MP4","MKV","MOV","TS","WEBM"]}},"safety":"SAFE","documentation":{"description":"The format of a video media item.","plainTextDescription":"The format of a video media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts video frames as images.","plainTextDescription":"Extracts video frames as images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscriptionLanguage"},"type":{"type":"enum","enum":{"values":["AF","AM","AR","AS","AZ","BA","BE","BG","BN","BO","BR","BS","CA","CS","CY","DA","DE","EL","EN","ES","ET","EU","FA","FI","FO","FR","GL","GU","HA","HAW","HE","HI","HR","HT","HU","HY","ID","IS","IT","JA","JW","KA","KK","KM","KN","KO","LA","LB","LN","LO","LT","LV","MG","MI","MK","ML","MN","MR","MS","MT","MY","NE","NL","NN","NO","OC","PA","PL","PS","PT","RO","RU","SA","SD","SI","SK","SL","SN","SO","SQ","SR","SU","SV","SW","TA","TE","TG","TH","TK","TL","TR","TT","UK","UR","UZ","VI","YI","YO","YUE","ZH","AFRIKAANS","ALBANIAN","AMHARIC","ARABIC","ARMENIAN","ASSAMESE","AZERBAIJANI","BASHKIR","BASQUE","BELARUSIAN","BENGALI","BOSNIAN","BRETON","BULGARIAN","BURMESE","CANTONESE","CASTILIAN","CATALAN","CHINESE","CROATIAN","CZECH","DANISH","DUTCH","ENGLISH","ESTONIAN","FAROESE","FINNISH","FLEMISH","FRENCH","GALICIAN","GEORGIAN","GERMAN","GREEK","GUJARATI","HAITIAN","HAITIAN_CREOLE","HAUSA","HAWAIIAN","HEBREW","HINDI","HUNGARIAN","ICELANDIC","INDONESIAN","ITALIAN","JAPANESE","JAVANESE","KANNADA","KAZAKH","KHMER","KOREAN","LAO","LATIN","LATVIAN","LETZEBURGESCH","LINGALA","LITHUANIAN","LUXEMBOURGISH","MACEDONIAN","MALAGASY","MALAY","MALAYALAM","MALTESE","MANDARIN","MAORI","MARATHI","MOLDAVIAN","MOLDOVAN","MONGOLIAN","MYANMAR","NEPALI","NORWEGIAN","NYNORSK","OCCITAN","PANJABI","PASHTO","PERSIAN","POLISH","PORTUGUESE","PUNJABI","PUSHTO","ROMANIAN","RUSSIAN","SANSKRIT","SERBIAN","SHONA","SINDHI","SINHALA","SINHALESE","SLOVAK","SLOVENIAN","SOMALI","SPANISH","SUNDANESE","SWAHILI","SWEDISH","TAGALOG","TAJIK","TAMIL","TATAR","TELUGU","THAI","TIBETAN","TURKISH","TURKMEN","UKRAINIAN","URDU","UZBEK","VALENCIAN","VIETNAMESE","WELSH","YIDDISH","YORUBA"]}},"safety":"SAFE","documentation":{"description":"Language codes for audio transcription.\nIf not specified, the language will be auto-detected from the first 30 seconds of audio.\n","plainTextDescription":"Language codes for audio transcription.\nIf not specified, the language will be auto-detected from the first 30 seconds of audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CoordinateReferenceSystem"},"type":{"type":"object","object":{"properties":{"wkt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The Well-Known Text representation of the CRS.","plainTextDescription":"The Well-Known Text representation of the CRS.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The coordinate reference system for geo-referenced imagery.","plainTextDescription":"The coordinate reference system for geo-referenced imagery.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrMode"},"type":{"type":"enum","enum":{"values":["AUTO","ELECTRONIC","SCAN"]}},"safety":"SAFE","documentation":{"description":"OCR mode for document extraction.","plainTextDescription":"OCR mode for document extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionParameters"},"type":{"type":"object","object":{"properties":{"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguage"}}}}},"safety":"SAFE","documentation":{"description":"The languages to use for extraction.","plainTextDescription":"The languages to use for extraction.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Parameters for layout-aware content extraction.","plainTextDescription":"Parameters for layout-aware content extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"},"type":{"type":"object","object":{"properties":{"outputFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrOutputFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"}}}}},"safety":"UNSAFE","documentation":{"description":"The languages or scripts to use for OCR.","plainTextDescription":"The languages or scripts to use for OCR.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Parameters for OCR (Optical Character Recognition) operations.","plainTextDescription":"Parameters for OCR (Optical Character Recognition) operations.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Modality"},"type":{"type":"enum","enum":{"values":["AR","ASMT","AU","BDUS","BI","BMD","CR","CT","CTPROTOCOL","DG","DOC","DX","ECG","EPS","ES","FID","GM","HC","HD","IO","IOL","IVOCT","IVUS","KER","KO","LEN","LS","MG","MR","M3D","NM","OAM","OCT","OP","OPM","OPT","OPTBSV","OPTENF","OPV","OSS","OT","PLAN","PR","PT","PX","REG","RESP","RF","RG","RTDOSE","RTIMAGE","RTINTENT","RTPLAN","RTRAD","RTRECORD","RTSEGANN","RTSTRUCT","RWV","SEG","SM","SMR","SR","SRF","STAIN","TEXTUREMAP","TG","US","VA","XA","XC","AS","CD","CF","CP","CS","DD","DF","DM","DS","EC","FA","FS","LP","MA","MS","OPR","ST","VF"]}},"safety":"SAFE","documentation":{"description":"DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification. \nhttps://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1\n","plainTextDescription":"DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification.\nhttps://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpec"},"type":{"type":"object","object":{"properties":{"modelLocator":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LanguageModelLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"systemPrompt":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"System prompt for the LLM.","plainTextDescription":"System prompt for the LLM.","example":[]}},"userPrompt":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"User prompt for the LLM.","plainTextDescription":"User prompt for the LLM.","example":[]}},"maxTokens":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Maximum number of tokens per request to generate.","plainTextDescription":"Maximum number of tokens per request to generate.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Standard chat-based LLM specification with system and user prompts.","plainTextDescription":"Standard chat-based LLM specification with system and user prompts.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetTimestampsForSceneFramesOperation"},"type":{"type":"object","object":{"properties":{"sceneScore":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SceneScore"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns a list of timestamps for scene frames in the video as JSON.","plainTextDescription":"Returns a list of timestamps for scene frames in the video as JSON.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscribeTextEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"plainTextNoSegmentData":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PlainTextNoSegmentData"}}}},"json":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscribeJson"}}}},"pttml":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Pttml"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for transcription results.","plainTextDescription":"The output format for transcription results.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemResponse"},"type":{"type":"object","object":{"properties":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Response after successfully registering a media item.","plainTextDescription":"Response after successfully registering a media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EncryptImageOperation"},"type":{"type":"object","object":{"properties":{"polygons":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageRegionPolygon"}}}}},"safety":"SAFE","documentation":{"description":"The polygons defining the regions to encrypt.","plainTextDescription":"The polygons defining the regions to encrypt.","example":[]}},"cipherLicenseRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The resource identifier for the cipher license.","plainTextDescription":"The resource identifier for the cipher license.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Encrypts bounding boxes in an image using a commutative encryption algorithm.","plainTextDescription":"Encrypts bounding boxes in an image using a commutative encryption algorithm.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrScriptWrapper"},"type":{"type":"object","object":{"properties":{"script":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrScript"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Wrapper for an OCR script.","plainTextDescription":"Wrapper for an OCR script.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RotateImageOperation"},"type":{"type":"object","object":{"properties":{"angle":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RotationAngle"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Rotates an image clockwise by the specified angle.","plainTextDescription":"Rotates an image clockwise by the specified angle.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractUnstructuredTextFromPageOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The page number.","plainTextDescription":"The page number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts unstructured text from a specified page.","plainTextDescription":"Extracts unstructured text from a specified page.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PutMediaItemResponse"},"type":{"type":"object","object":{"properties":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms documents to documents.","plainTextDescription":"Transforms documents to documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TileImageOperation"},"type":{"type":"object","object":{"properties":{"zoom":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The zoom level of the tile.","plainTextDescription":"The zoom level of the tile.","example":[]}},"x":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The x coordinate of the tile.","plainTextDescription":"The x coordinate of the tile.","example":[]}},"y":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The y coordinate of the tile.","plainTextDescription":"The y coordinate of the tile.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Generates Slippy map tiles (EPSG 3857) from a geo-embedded image.\nOnly supported for geo-embedded TIFF and NITF images with at most 100M square pixels.\n","plainTextDescription":"Generates Slippy map tiles (EPSG 3857) from a geo-embedded image.\nOnly supported for geo-embedded TIFF and NITF images with at most 100M square pixels.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Group"},"type":{"type":"object","object":{"properties":{"groupName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the group.","plainTextDescription":"The name of the group.","example":[]}},"mailboxes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"}}}}},"safety":"UNSAFE","documentation":{"description":"The mailboxes in the group.","plainTextDescription":"The mailboxes in the group.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A named group of mailboxes.","plainTextDescription":"A named group of mailboxes.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"createPdf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CreatePdfOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for image to document conversion.","plainTextDescription":"The operation to perform for image to document conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RenderPageToFitBoundingBoxOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed page number to render. Defaults to the first page if not specified.","plainTextDescription":"The zero-indexed page number to render. Defaults to the first page if not specified.","example":[]}},"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The width of the bounding box in pixels.","plainTextDescription":"The width of the bounding box in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The height of the bounding box in pixels.","plainTextDescription":"The height of the bounding box in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Renders a PDF page to maximally fit within a bounding box while preserving aspect ratio.\n","plainTextDescription":"Renders a PDF page to maximally fit within a bounding box while preserving aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"jpg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"JpgFormat"}}}},"tiff":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TiffFormat"}}}},"png":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PngFormat"}}}},"webp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"WebpFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding imagery.","plainTextDescription":"The output format for encoding imagery.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscodeOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Encodes video to the specified format.","plainTextDescription":"Encodes video to the specified format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Config"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TextOutputFormat"}}}}},"safety":"SAFE","documentation":{"example":[]}},"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"}}}}},"safety":"UNSAFE","documentation":{"description":"List of OCR languages or scripts to use.","plainTextDescription":"List of OCR languages or scripts to use.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for v2 document text extraction.","plainTextDescription":"Configuration for v2 document text extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Renders DICOM (Digital Imaging and Communications in Medicine) files as images.","plainTextDescription":"Renders DICOM (Digital Imaging and Communications in Medicine) files as images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GpsMetadata"},"type":{"type":"object","object":{"properties":{"latitude":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"longitude":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"altitude":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"GPS location metadata extracted from EXIF data embedded in the image.","plainTextDescription":"GPS location metadata extracted from EXIF data embedded in the image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpecWrapper"},"type":{"type":"object","object":{"properties":{"chat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpec"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for chat-based LLM specification.","plainTextDescription":"Wrapper for chat-based LLM specification.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"channel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelOperation"}}}},"chunk":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioChunkOperation"}}}},"convert":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ConvertAudioOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform on audio.","plainTextDescription":"The operation to perform on audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GeoMetadata"},"type":{"type":"object","object":{"properties":{"crs":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CoordinateReferenceSystem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"geotransform":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AffineTransform"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gcpInfo":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GcpList"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gpsData":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GpsMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Embedded geo-referencing data for an image.","plainTextDescription":"Embedded geo-referencing data for an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ResizingMode"},"type":{"type":"enum","enum":{"values":["RESIZING","FIT_INTO_BOUNDING_BOX"]}},"safety":"SAFE","documentation":{"description":"Image resizing strategy.","plainTextDescription":"Image resizing strategy.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GcpList"},"type":{"type":"object","object":{"properties":{"gcps":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GroundControlPoint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A list of ground control points for geo-referencing.","plainTextDescription":"A list of ground control points for geo-referencing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ApiNameLocatorWrapper"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The API name of the language model.","plainTextDescription":"The API name of the language model.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Wrapper for API name-based model locator.","plainTextDescription":"Wrapper for API name-based model locator.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PerformanceMode"},"type":{"type":"enum","enum":{"values":["MORE_ECONOMICAL","MORE_PERFORMANT"]}},"safety":"SAFE","documentation":{"description":"The performance mode for transcription.","plainTextDescription":"The performance mode for transcription.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemRequest"},"type":{"type":"object","object":{"properties":{"transformation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Transformation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to transform a media item.","plainTextDescription":"Request to transform a media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"specification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioSpecification"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for audio media items.","plainTextDescription":"Metadata for audio media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LlmSpec"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"chat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpecWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specification for language model requests.","plainTextDescription":"Specification for language model requests.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImagePixelCoordinate"},"type":{"type":"object","object":{"properties":{"x":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Coordinate on the x-axis (width).","plainTextDescription":"Coordinate on the x-axis (width).","example":[]}},"y":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Coordinate on the y-axis (height).","plainTextDescription":"Coordinate on the y-axis (height).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Coordinate of a pixel in an image (x, y). Top left corner of the image is (0, 0).\n","plainTextDescription":"Coordinate of a pixel in an image (x, y). Top left corner of the image is (0, 0).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RotationAngle"},"type":{"type":"enum","enum":{"values":["DEGREE_90","DEGREE_180","DEGREE_270","UNKNOWN"]}},"safety":"SAFE","documentation":{"description":"The rotation angle from EXIF orientation.","plainTextDescription":"The rotation angle from EXIF orientation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Model3dMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Model3dDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"modelType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Model3dType"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for 3D model media items.","plainTextDescription":"Metadata for 3D model media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TiffFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"TIFF image format.","plainTextDescription":"TIFF image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractFormFieldsOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts form field data from a PDF document.","plainTextDescription":"Extracts form field data from a PDF document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscribeOperation"},"type":{"type":"object","object":{"properties":{"language":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscriptionLanguage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"diarize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to perform speaker diarization. Defaults to false.\nNot supported in economical performance mode.\n","plainTextDescription":"Whether to perform speaker diarization. Defaults to false.\nNot supported in economical performance mode.","example":[]}},"outputFormat":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscribeTextEncodeFormat"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"performanceMode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PerformanceMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transcribes speech in audio to text.","plainTextDescription":"Transcribes speech in audio to text.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguage"},"type":{"type":"enum","enum":{"values":["AFR","AMH","ARA","ASM","AZE","AZE_CYRL","BEL","BEN","BOD","BOS","BRE","BUL","CAT","CEB","CES","CHI_SIM","CHI_SIM_VERT","CHI_TRA","CHI_TRA_VERT","CHR","COS","CYM","DAN","DEU","DIV","DZO","ELL","ENG","ENM","EPO","EST","EUS","FAO","FAS","FIL","FIN","FRA","FRM","FRY","GLA","GLE","GLG","GRC","GUJ","HAT","HEB","HIN","HRV","HUN","HYE","IKU","IND","ISL","ITA","ITA_OLD","JAV","JPN","JPN_VERT","KAN","KAT","KAT_OLD","KAZ","KHM","KIR","KMR","KOR","KOR_VERT","LAO","LAT","LAV","LIT","LTZ","MAL","MAR","MKD","MLT","MON","MRI","MSA","MYA","NEP","NLD","NOR","OCI","ORI","OSD","PAN","POL","POR","PUS","QUE","RON","RUS","SAN","SIN","SLK","SLV","SND","SPA","SPA_OLD","SQI","SRP","SRP_LATN","SUN","SWA","SWE","SYR","TAM","TAT","TEL","TGK","THA","TIR","TON","TUR","UIG","UKR","URD","UZB","UZB_CYRL","VIE","YID","YOR"]}},"safety":"SAFE","documentation":{"description":"Language codes for OCR.","plainTextDescription":"Language codes for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastBinarize"},"type":{"type":"object","object":{"properties":{"threshold":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The threshold value (0-255). Pixels with intensity below this value become black,\nothers become white. If not specified, the threshold is computed automatically.\n","plainTextDescription":"The threshold value (0-255). Pixels with intensity below this value become black,\nothers become white. If not specified, the threshold is computed automatically.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Binarize contrast operation.","plainTextDescription":"Binarize contrast operation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPageOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The page number to perform OCR on.","plainTextDescription":"The page number to perform OCR on.","example":[]}},"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Performs OCR (Optical Character Recognition) on a specific page of a document.","plainTextDescription":"Performs OCR (Optical Character Recognition) on a specific page of a document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AvailableEmbeddingModelIds"},"type":{"type":"enum","enum":{"values":["GOOGLE_SIGLIP_2"]}},"safety":"SAFE","documentation":{"description":"Available embedding models that can be used with the service.","plainTextDescription":"Available embedding models that can be used with the service.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"v1":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformationV1"}}}}}}},"safety":"UNSAFE","documentation":{"description":"DICOM meta information.","plainTextDescription":"DICOM meta information.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageryDecodeFormat"},"type":{"type":"enum","enum":{"values":["BMP","TIFF","NITF","JP2K","JPG","PNG","WEBP"]}},"safety":"SAFE","documentation":{"description":"The format of an imagery media item.","plainTextDescription":"The format of an imagery media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformationV1"},"type":{"type":"object","object":{"properties":{"mediaStorageSop":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The Media Storage SOP (Service-Object Pair) Class UID, which identifies \nthe type of DICOM object stored (e.g., CT Image, MR Image).\n","plainTextDescription":"The Media Storage SOP (Service-Object Pair) Class UID, which identifies\nthe type of DICOM object stored (e.g., CT Image, MR Image).","example":[]}},"mediaStorageSopInstance":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The Media Storage SOP Instance UID.","plainTextDescription":"The Media Storage SOP Instance UID.","example":[]}},"transferSyntax":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The Transfer Syntax UID, which specifies how the DICOM data is encoded \n(e.g., compression method, byte ordering).\n","plainTextDescription":"The Transfer Syntax UID, which specifies how the DICOM data is encoded\n(e.g., compression method, byte ordering).","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"DICOM meta information version 1.","plainTextDescription":"DICOM meta information version 1.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoSpecification"},"type":{"type":"object","object":{"properties":{"bitRate":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Approximate (average) bits per second of the video, rounded up in case of a fractional average bits per second.\n","plainTextDescription":"Approximate (average) bits per second of the video, rounded up in case of a fractional average bits per second.","example":[]}},"durationSeconds":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"Approximate duration of the video, in seconds with up to two decimal digits (rounded up).\n","plainTextDescription":"Approximate duration of the video, in seconds with up to two decimal digits (rounded up).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Technical specifications for video media items.","plainTextDescription":"Technical specifications for video media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"convertSheetToJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ConvertSheetToJsonOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for spreadsheet to text conversion.","plainTextDescription":"The operation to perform for spreadsheet to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mp3":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mp3Format"}}}},"wav":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"WavEncodeFormat"}}}},"ts":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TsAudioContainerFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding audio.","plainTextDescription":"The output format for encoding audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageWrapper"},"type":{"type":"object","object":{"properties":{"language":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguage"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Wrapper for an OCR language.","plainTextDescription":"Wrapper for an OCR language.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SceneScore"},"type":{"type":"enum","enum":{"values":["MORE_SENSITIVE","STANDARD","LESS_SENSITIVE"]}},"safety":"SAFE","documentation":{"description":"The sensitivity threshold for scene detection.","plainTextDescription":"The sensitivity threshold for scene detection.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Generates embeddings from images.","plainTextDescription":"Generates embeddings from images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSet"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaSetName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parentFolderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FolderRid"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TsVideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MPEG Transport Stream video container format.","plainTextDescription":"MPEG Transport Stream video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"FlipAxis"},"type":{"type":"enum","enum":{"values":["HORIZONTAL","VERTICAL","UNKNOWN"]}},"safety":"SAFE","documentation":{"description":"The flip axis from EXIF orientation.","plainTextDescription":"The flip axis from EXIF orientation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"specification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoSpecification"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for video media items.","plainTextDescription":"Metadata for video media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BandInfo"},"type":{"type":"object","object":{"properties":{"dataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DataType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"colorInterpretation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ColorInterpretation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"paletteInterpretation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PaletteInterpretation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"unitInterpretation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"UnitInterpretation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Information about a band in an image.","plainTextDescription":"Information about a band in an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MailboxWrapper"},"type":{"type":"object","object":{"properties":{"mailbox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A wrapper for a mailbox in the MailboxOrGroup union.","plainTextDescription":"A wrapper for a mailbox in the MailboxOrGroup union.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaSetResponse"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSchema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaSchema"}}},"safety":"SAFE","documentation":{"example":[]}},"defaultBranchName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"transactionPolicy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionPolicy"}}},"safety":"UNSAFE","documentation":{"example":[]}},"pathsRequired":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether media items in this media set require paths.","plainTextDescription":"Whether media items in this media set require paths.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Information about a media set.","plainTextDescription":"Information about a media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TextOutputFormat"},"type":{"type":"enum","enum":{"values":["TEXT","MARKDOWN","HTML"]}},"safety":"SAFE","documentation":{"description":"Format in which to return extracted text.","plainTextDescription":"Format in which to return extracted text.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetEmailBodyOperation"},"type":{"type":"object","object":{"properties":{"outputFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextEncodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Gets the email body in the specified format.","plainTextDescription":"Gets the email body in the specified format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaType"},"type":{"type":"enum","enum":{"values":["IMAGE","MULTI_FRAME_IMAGE","VIDEO","STRUCTURED_REPORT"]}},"safety":"SAFE","documentation":{"description":"The type of DICOM media.","plainTextDescription":"The type of DICOM media.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The key of an image attribute within a domain.","plainTextDescription":"The key of an image attribute within a domain.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"renderPageToFitBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RenderPageToFitBoundingBoxOperation"}}}},"renderPage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RenderPageOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for document to image conversion.","plainTextDescription":"The operation to perform for document to image conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractFirstFrame":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractFirstFrameOperation"}}}},"extractFramesAtTimestamps":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractFramesAtTimestampsOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to image conversion.","plainTextDescription":"The operation to perform for video to image conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BoundingBoxGeometry"},"type":{"type":"object","object":{"properties":{"boundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BoundingBox"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A rectangular bounding box geometry for annotations.","plainTextDescription":"A rectangular bounding box geometry for annotations.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LogicalTimestamp"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"A number representing a logical ordering to be used for transactions, etc.\nThis can be interpreted as a timestamp in microseconds, but may differ slightly from system clock time due \nto clock drift and slight adjustments for the sake of ordering.\n\nOnly positive timestamps (representing times after epoch) are supported.\n","plainTextDescription":"A number representing a logical ordering to be used for transactions, etc.\nThis can be interpreted as a timestamp in microseconds, but may differ slightly from system clock time due\nto clock drift and slight adjustments for the sake of ordering.\nOnly positive timestamps (representing times after epoch) are supported.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The display name of the mailbox.","plainTextDescription":"The display name of the mailbox.","example":[]}},"emailAddress":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The email address of the mailbox.","plainTextDescription":"The email address of the mailbox.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An email mailbox with an optional display name and email address.","plainTextDescription":"An email mailbox with an optional display name and email address.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscribeJson"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"JSON transcription output format.","plainTextDescription":"JSON transcription output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DataType"},"type":{"type":"enum","enum":{"values":["UNDEFINED","BYTE","UINT16","INT16","UINT32","INT32","FLOAT32","FLOAT64","COMPLEX_INT16","COMPLEX_INT32","COMPLEX_FLOAT32","COMPLEX_FLOAT64","UINT64","INT64","INT8"]}},"safety":"SAFE","documentation":{"description":"The data type of a band.","plainTextDescription":"The data type of a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ArchiveEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts video frames to an archive format.","plainTextDescription":"Extracts video frames to an archive format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Mp3Format"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MP3 audio format.","plainTextDescription":"MP3 audio format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Dimensions"},"type":{"type":"object","object":{"properties":{"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The width of the image in pixels.","plainTextDescription":"The width of the image in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The height of the image in pixels.","plainTextDescription":"The height of the image in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"The dimensions of an image.","plainTextDescription":"The dimensions of an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrScript"},"type":{"type":"enum","enum":{"values":["ARABIC","ARMENIAN","BENGALI","CANADIAN_ABORIGINAL","CHEROKEE","CYRILLIC","DEVANAGARI","ETHIOPIC","FRAKTUR","GEORGIAN","GREEK","GUJARATI","GURMUKHI","HAN_SIMPLIFIED","HAN_SIMPLIFIED_VERT","HAN_TRADITIONAL","HAN_TRADITIONAL_VERT","HANGUL","HANGUL_VERT","HEBREW","JAPANESE","JAPANESE_VERT","KANNADA","KHMER","LAO","LATIN","MALAYALAM","MYANMAR","ORIYA","SINHALA","SYRIAC","TAMIL","TELUGU","THAANA","THAI","TIBETAN","VIETNAMESE"]}},"safety":"SAFE","documentation":{"description":"Script codes for OCR.","plainTextDescription":"Script codes for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts text from documents.","plainTextDescription":"Extracts text from documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetDecodeFormat"},"type":{"type":"enum","enum":{"values":["XLSX"]}},"safety":"SAFE","documentation":{"description":"The format of a spreadsheet media item.","plainTextDescription":"The format of a spreadsheet media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractVlmTextOperation"},"type":{"type":"object","object":{"properties":{"llmSpec":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LlmSpec"}}},"safety":"UNSAFE","documentation":{"example":[]}},"preprocessingConfiguration":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VlmPreprocessingConfig"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"imageSpec":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageSpec"}}}}},"safety":"SAFE","documentation":{"example":[]}},"outputFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VlmOutputFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"pageRange":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PageRange"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extract text from a document using vision language models (VLMs).\nVLMs can understand document layout and structure more intelligently than traditional OCR.\n","plainTextDescription":"Extract text from a document using vision language models (VLMs).\nVLMs can understand document layout and structure more intelligently than traditional OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ResizeImageOperation"},"type":{"type":"object","object":{"properties":{"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}},"autoOrient":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to automatically orient the image based on EXIF metadata.\n","plainTextDescription":"Whether to automatically orient the image based on EXIF metadata.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Resizes an image to the specified dimensions.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Resizes an image to the specified dimensions.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConvertDocumentOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Converts a document to PDF format.","plainTextDescription":"Converts a document to PDF format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageSpec"},"type":{"type":"object","object":{"properties":{"resizingMode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ResizingMode"}}},"safety":"SAFE","documentation":{"example":[]}},"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Target height in pixels.","plainTextDescription":"Target height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Target width in pixels.","plainTextDescription":"Target width in pixels.","example":[]}},"mimeType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specification for image processing parameters used in vision-based extraction.\nControls how document pages are converted to images before being sent to vision models.\n","plainTextDescription":"Specification for image processing parameters used in vision-based extraction.\nControls how document pages are converted to images before being sent to vision models.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Model3dDecodeFormat"},"type":{"type":"enum","enum":{"values":["LAS","PLY","OBJ"]}},"safety":"SAFE","documentation":{"description":"The format of a 3D model media item.","plainTextDescription":"The format of a 3D model media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts audio to text.","plainTextDescription":"Converts audio to text.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastEqualize"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Equalizes the histogram of an image to improve contrast.","plainTextDescription":"Equalizes the histogram of an image to improve contrast.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Color"},"type":{"type":"object","object":{"properties":{"r":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Red component (0-255).","plainTextDescription":"Red component (0-255).","example":[]}},"g":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Green component (0-255).","plainTextDescription":"Green component (0-255).","example":[]}},"b":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Blue component (0-255).","plainTextDescription":"Blue component (0-255).","example":[]}},"a":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"Alpha component (0-1, where 0 is transparent and 1 is opaque).","plainTextDescription":"Alpha component (0-1, where 0 is transparent and 1 is opaque).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"An RGBA color value.","plainTextDescription":"An RGBA color value.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConvertSheetToJsonOperation"},"type":{"type":"object","object":{"properties":{"sheetName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The sheet name.","plainTextDescription":"The sheet name.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts a specified sheet to JSON format.","plainTextDescription":"Converts a specified sheet to JSON format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PageRange"},"type":{"type":"object","object":{"properties":{"startPageInclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Start page index (0-based, inclusive). If not provided, defaults to start of document.","plainTextDescription":"Start page index (0-based, inclusive). If not provided, defaults to start of document.","example":[]}},"endPageExclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"End page index (0-based, exclusive). If not provided, defaults to end of document.","plainTextDescription":"End page index (0-based, exclusive). If not provided, defaults to end of document.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Page range for document extraction.","plainTextDescription":"Page range for document extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Renders document pages as images.","plainTextDescription":"Renders document pages as images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemInfoResponse"},"type":{"type":"object","object":{"properties":{"viewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"logicalTimestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LogicalTimestamp"}}},"safety":"SAFE","documentation":{"example":[]}},"attribution":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaAttribution"}}}}},"safety":"SAFE","documentation":{"example":[]}},"originallyUploadedFileMimeType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"mimeType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GrayscaleImageOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Converts an image to grayscale.","plainTextDescription":"Converts an image to grayscale.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TarFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"TAR archive format.","plainTextDescription":"TAR archive format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"renderImageLayer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RenderImageLayerOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for DICOM to image conversion.","plainTextDescription":"The operation to perform for DICOM to image conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemRequest"},"type":{"type":"object","object":{"properties":{"physicalItemName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The relative path within the federated media store where the media item exists.","plainTextDescription":"The relative path within the federated media store where the media item exists.","example":[]}},"mediaItemPath":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to register a media item from a federated store.","plainTextDescription":"Request to register a media item from a federated store.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSetName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioChunkOperation"},"type":{"type":"object","object":{"properties":{"chunkDurationMilliseconds":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Duration of each chunk in milliseconds.","plainTextDescription":"Duration of each chunk in milliseconds.","example":[]}},"encodeFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"chunkIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The chunk index to retain.","plainTextDescription":"The chunk index to retain.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Chunks audio into smaller segments of the specified duration.","plainTextDescription":"Chunks audio into smaller segments of the specified duration.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentExtractLayoutAwareContentOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionParameters"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts content from a document with layout information preserved.","plainTextDescription":"Extracts content from a document with layout information preserved.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractFramesAtTimestampsOperation"},"type":{"type":"object","object":{"properties":{"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"description":"The timestamp in seconds.","plainTextDescription":"The timestamp in seconds.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts frames from the video at specified timestamps.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Extracts frames from the video at specified timestamps.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemRidByPathResponse"},"type":{"type":"object","object":{"properties":{"mediaItemRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Mp4VideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MP4 video container format.","plainTextDescription":"MP4 video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"WaveformOperation"},"type":{"type":"object","object":{"properties":{"peaksPerSecond":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The number of peaks per second (1-1000).","plainTextDescription":"The number of peaks per second (1-1000).","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Generates waveform visualization data from audio.\nReturns JSON with normalized doubles (0-1) representing amplitude.\n","plainTextDescription":"Generates waveform visualization data from audio.\nReturns JSON with normalized doubles (0-1) representing amplitude.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioDecodeFormat"},"type":{"type":"enum","enum":{"values":["FLAC","MP2","MP3","MP4","NIST_SPHERE","OGG","WAV","WEBM"]}},"safety":"SAFE","documentation":{"description":"The format of an audio media item.","plainTextDescription":"The format of an audio media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"transcode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscodeOperation"}}}},"chunk":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoChunkOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform on the video.","plainTextDescription":"The operation to perform on the video.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SlicePdfRangeOperation"},"type":{"type":"object","object":{"properties":{"startPageInclusive":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The zero-indexed start page (inclusive).","plainTextDescription":"The zero-indexed start page (inclusive).","example":[]}},"endPageExclusive":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The zero-indexed end page (exclusive).","plainTextDescription":"The zero-indexed end page (exclusive).","example":[]}},"strictlyEnforceEndPage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true (default), the operation fails if endPage exceeds the document's page count.\nIf false, ends at min(endPage, lastPage).\n","plainTextDescription":"If true (default), the operation fails if endPage exceeds the document's page count.\nIf false, ends at min(endPage, lastPage).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Slices a PDF to a specified page range.","plainTextDescription":"Slices a PDF to a specified page range.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentDecodeFormat"},"type":{"type":"enum","enum":{"values":["PDF","DOC","DOCX","TXT","PPTX","RTF"]}},"safety":"SAFE","documentation":{"description":"The format of a document media item.","plainTextDescription":"The format of a document media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeDomain"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The domain of an image attribute.","plainTextDescription":"The domain of an image attribute.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrHocrOutputFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"hOCR (HTML-based OCR) output format.","plainTextDescription":"hOCR (HTML-based OCR) output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemXmlFormat"},"type":{"type":"enum","enum":{"values":["DOCX","XLSX","PPTX"]}},"safety":"SAFE","documentation":{"description":"Format of the media item attempted to be decoded based on the XML structure.","plainTextDescription":"Format of the media item attempted to be decoded based on the XML structure.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TsAudioContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MPEG Transport Stream audio container format.","plainTextDescription":"MPEG Transport Stream audio container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractAudio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractAudioOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to audio conversion.","plainTextDescription":"The operation to perform for video to audio conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BoundingBox"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The left coordinate of the bounding box.","plainTextDescription":"The left coordinate of the bounding box.","example":[]}},"top":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The top coordinate of the bounding box.","plainTextDescription":"The top coordinate of the bounding box.","example":[]}},"width":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The width of the bounding box.","plainTextDescription":"The width of the bounding box.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The height of the bounding box.","plainTextDescription":"The height of the bounding box.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A rectangular bounding box for annotations.","plainTextDescription":"A rectangular bounding box for annotations.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MovVideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MOV (QuickTime) video container format.","plainTextDescription":"MOV (QuickTime) video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Annotation"},"type":{"type":"object","object":{"properties":{"geometry":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AnnotateGeometry"}}},"safety":"UNSAFE","documentation":{"example":[]}},"label":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"An optional text label to display with the annotation.","plainTextDescription":"An optional text label to display with the annotation.","example":[]}},"color":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Color"}}}}},"safety":"SAFE","documentation":{"example":[]}},"thickness":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"The thickness of the annotation lines.","plainTextDescription":"The thickness of the annotation lines.","example":[]}},"fontSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The font size for the label text.","plainTextDescription":"The font size for the label text.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An annotation to draw on an image.","plainTextDescription":"An annotation to draw on an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailDecodeFormat"},"type":{"type":"enum","enum":{"values":["EML"]}},"safety":"SAFE","documentation":{"description":"The format of an email media item.","plainTextDescription":"The format of an email media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Operation"},"type":{"type":"object","object":{"properties":{"pageRange":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PageRange"}}}}},"safety":"SAFE","documentation":{"example":[]}},"config":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extract text across all pages using the v2 text extraction endpoint with per page text.\nThis only supports PDFs.\n","plainTextDescription":"Extract text across all pages using the v2 text extraction endpoint with per page text.\nThis only supports PDFs.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts images to documents.","plainTextDescription":"Converts images to documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"rotate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RotateImageOperation"}}}},"resizeToFitBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ResizeToFitBoundingBoxOperation"}}}},"encrypt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EncryptImageOperation"}}}},"contrast":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastImageOperation"}}}},"tile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TileImageOperation"}}}},"resize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ResizeImageOperation"}}}},"annotate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AnnotateImageOperation"}}}},"decrypt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DecryptImageOperation"}}}},"crop":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CropImageOperation"}}}},"grayscale":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GrayscaleImageOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An operation to perform on an image.","plainTextDescription":"An operation to perform on an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ArchiveEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"tar":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TarFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding archives.","plainTextDescription":"The output format for encoding archives.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"getEmailAttachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetEmailAttachmentOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for email to attachment extraction.","plainTextDescription":"The operation to perform for email to attachment extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DecryptImageOperation"},"type":{"type":"object","object":{"properties":{"polygons":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageRegionPolygon"}}}}},"safety":"SAFE","documentation":{"description":"The polygons defining the regions to decrypt.","plainTextDescription":"The polygons defining the regions to decrypt.","example":[]}},"cipherLicenseRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The resource identifier for the cipher license.","plainTextDescription":"The resource identifier for the cipher license.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Decrypts bounding boxes in an image using a commutative encryption algorithm.","plainTextDescription":"Decrypts bounding boxes in an image using a commutative encryption algorithm.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PdfFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"PDF document format.","plainTextDescription":"PDF document format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPagesOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageNumber":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The page number.","plainTextDescription":"The page number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Creates access patterns for OCR across pages of a document.","plainTextDescription":"Creates access patterns for OCR across pages of a document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts spreadsheet data to text/JSON.","plainTextDescription":"Converts spreadsheet data to text/JSON.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CadUnits"},"type":{"type":"object","object":{"properties":{"lengthUnit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Raw declared length unit name, for example MILLIMETRE, METRE, INCH, or FOOT. Consumers should match\ncase-insensitively and tolerate unknown values.\n","plainTextDescription":"Raw declared length unit name, for example MILLIMETRE, METRE, INCH, or FOOT. Consumers should match\ncase-insensitively and tolerate unknown values.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Units declared in a CAD file.","plainTextDescription":"Units declared in a CAD file.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VlmPreprocessingConfig"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"layoutAware":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwarePreprocessingWrapper"}}}},"extractText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextPreprocessingWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Preprocessing configuration for VLM extraction.","plainTextDescription":"Preprocessing configuration for VLM extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"getTimestampsForSceneFrames":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetTimestampsForSceneFramesOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to text conversion.","plainTextDescription":"The operation to perform for video to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PngFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"PNG image format.","plainTextDescription":"PNG image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MkvVideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MKV (Matroska) video container format.","plainTextDescription":"MKV (Matroska) video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"generateEmbedding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GenerateEmbeddingOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for image to embedding conversion.","plainTextDescription":"The operation to perform for image to embedding conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts text from images.","plainTextDescription":"Extracts text from images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetTransformationJobStatusResponse"},"type":{"type":"object","object":{"properties":{"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"jobId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response containing the status of a transformation job.","plainTextDescription":"Response containing the status of a transformation job.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"NoTransactionsTransactionPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Writes are not part of a transaction and are immediately visible.\nCalls to create transaction or commit transaction will error.\n","plainTextDescription":"Writes are not part of a transaction and are immediately visible.\nCalls to create transaction or commit transaction will error.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"sender":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"}}}}},"safety":"UNSAFE","documentation":{"description":"The sender(s) of the email.","plainTextDescription":"The sender(s) of the email.","example":[]}},"date":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"The date the email was sent.","plainTextDescription":"The date the email was sent.","example":[]}},"attachmentCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The number of attachments in the email.","plainTextDescription":"The number of attachments in the email.","example":[]}},"to":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MailboxOrGroup"}}}}},"safety":"UNSAFE","documentation":{"description":"The recipient(s) of the email.","plainTextDescription":"The recipient(s) of the email.","example":[]}},"cc":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MailboxOrGroup"}}}}},"safety":"UNSAFE","documentation":{"description":"The CC recipient(s) of the email.","plainTextDescription":"The CC recipient(s) of the email.","example":[]}},"subject":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The subject of the email.","plainTextDescription":"The subject of the email.","example":[]}},"attachments":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailAttachment"}}}}},"safety":"UNSAFE","documentation":{"description":"The attachments of the email.","plainTextDescription":"The attachments of the email.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for email media items.","plainTextDescription":"Metadata for email media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageryMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"dimensions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Dimensions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"bands":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BandInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"Information about the bands of the image, if available.","plainTextDescription":"Information about the bands of the image, if available.","example":[]}},"attributes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeDomain"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeKey"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}}}},"safety":"UNSAFE","documentation":{"description":"The metadata attributes described in the image header in the form of a map >.\nFor the default domain, or when the domain is not specified, the domain key will be the empty string (\"\").\n","plainTextDescription":"The metadata attributes described in the image header in the form of a map >.\nFor the default domain, or when the domain is not specified, the domain key will be the empty string (\"\").","example":[]}},"iccProfile":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The base64-encoded ICC profile for the image, if available.","plainTextDescription":"The base64-encoded ICC profile for the image, if available.","example":[]}},"geo":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GeoMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pages":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The number of pages associated with this image. Usually 1, but may be more for some formats\n(multi-page TIFFs, for example).\n","plainTextDescription":"The number of pages associated with this image. Usually 1, but may be more for some formats\n(multi-page TIFFs, for example).","example":[]}},"orientation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Orientation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for imagery (image) media items.","plainTextDescription":"Metadata for imagery (image) media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemMetadata"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"cad":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CadMediaItemMetadata"}}}},"document":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentMediaItemMetadata"}}}},"imagery":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryMediaItemMetadata"}}}},"spreadsheet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetMediaItemMetadata"}}}},"untyped":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"UntypedMediaItemMetadata"}}}},"audio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioMediaItemMetadata"}}}},"model3d":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Model3dMediaItemMetadata"}}}},"video":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoMediaItemMetadata"}}}},"dicom":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaItemMetadata"}}}},"email":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailMediaItemMetadata"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Detailed metadata about a media item, including type-specific information such as dimensions for images,\nduration for audio/video, page count for documents, etc.\n","plainTextDescription":"Detailed metadata about a media item, including type-specific information such as dimensions for images,\nduration for audio/video, page count for documents, etc.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PlainTextNoSegmentData"},"type":{"type":"object","object":{"properties":{"addTimestamps":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether to include timestamps in the output.","plainTextDescription":"Whether to include timestamps in the output.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Plain text transcription output format.","plainTextDescription":"Plain text transcription output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"An identifier which represents a transaction on a media set.\n","plainTextDescription":"An identifier which represents a transaction on a media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"metaInformation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformation"}}},"safety":"UNSAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaType"}}},"safety":"SAFE","documentation":{"example":[]}},"commonDataElements":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CommonDicomDataElements"}}},"safety":"UNSAFE","documentation":{"example":[]}},"otherDataElements":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomDataElementKey"}}},"valueType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"The data elements for a particular DICOM file outside of the media contained within it and the\ndata elements within the commonDataElements field.\n","plainTextDescription":"The data elements for a particular DICOM file outside of the media contained within it and the\ndata elements within the commonDataElements field.","example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.","plainTextDescription":"Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UntypedMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for untyped media items (media items without a recognized type).","plainTextDescription":"Metadata for untyped media items (media items without a recognized type).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AffineTransform"},"type":{"type":"object","object":{"properties":{"xTranslate":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"xScale":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"xShear":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"yTranslate":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"yShear":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"yScale":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An affine transformation for geo-referencing.","plainTextDescription":"An affine transformation for geo-referencing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationPendingResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AnnotateGeometry"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"boundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BoundingBoxGeometry"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The geometry for an annotation.","plainTextDescription":"The geometry for an annotation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CommonDicomDataElements"},"type":{"type":"object","object":{"properties":{"numberFrames":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"description":"The number of frames in the DICOM file.","plainTextDescription":"The number of frames in the DICOM file.","example":[]}},"modality":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Modality"}}}}},"safety":"SAFE","documentation":{"example":[]}},"patientId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The patient ID.","plainTextDescription":"The patient ID.","example":[]}},"studyId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The study ID.","plainTextDescription":"The study ID.","example":[]}},"studyUid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The study UID.","plainTextDescription":"The study UID.","example":[]}},"seriesUid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The series UID.","plainTextDescription":"The series UID.","example":[]}},"studyTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"description":"The study time.","plainTextDescription":"The study time.","example":[]}},"seriesTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"description":"The series time.","plainTextDescription":"The series time.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Common DICOM data elements.","plainTextDescription":"Common DICOM data elements.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractSceneFramesOperation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sceneScore":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SceneScore"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts all scene frames from a video as images in an archive.","plainTextDescription":"Extracts all scene frames from a video as images in an archive.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemResponse"},"type":{"type":"object","object":{"properties":{"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"jobId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response from initiating a media item transformation.","plainTextDescription":"Response from initiating a media item transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractLayoutAwareContent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageExtractLayoutAwareContentOperation"}}}},"ocr":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageOcrOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for image to text conversion.","plainTextDescription":"The operation to perform for image to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BatchTransactionsTransactionPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"All writes must be part of a transaction. Transactions are branch-scoped and created by calling\ncreate transaction. Writes are not visible until commit transaction is called.\n","plainTextDescription":"All writes must be part of a transaction. Transactions are branch-scoped and created by calling\ncreate transaction. Writes are not visible until commit transaction is called.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms video media items.","plainTextDescription":"Transforms video media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts attachments from email.","plainTextDescription":"Extracts attachments from email.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoChunkOperation"},"type":{"type":"object","object":{"properties":{"chunkDurationMilliseconds":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Duration of each chunk in milliseconds.","plainTextDescription":"Duration of each chunk in milliseconds.","example":[]}},"chunkIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The chunk index to retain.","plainTextDescription":"The chunk index to retain.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Chunks video into smaller segments of the specified duration.\nThe final chunk may be smaller than the specified duration.\n","plainTextDescription":"Chunks video into smaller segments of the specified duration.\nThe final chunk may be smaller than the specified duration.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractAllTextOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts text across all pages of the document.\nFor PDF documents, includes all text. For DocX documents, includes only regular paragraphs.\n","plainTextDescription":"Extracts text across all pages of the document.\nFor PDF documents, includes all text. For DocX documents, includes only regular paragraphs.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrTextOutputFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Plain text output format for OCR.","plainTextDescription":"Plain text output format for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RenderPageOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed page number to render. Defaults to the first page if not specified.","plainTextDescription":"The zero-indexed page number to render. Defaults to the first page if not specified.","example":[]}},"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Renders a PDF page as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Renders a PDF page as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"sheetNames":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The names of the sheets in the spreadsheet.","plainTextDescription":"The names of the sheets in the spreadsheet.","example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"title":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The title of the spreadsheet, if available.","plainTextDescription":"The title of the spreadsheet, if available.","example":[]}},"author":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The author of the spreadsheet, if available.","plainTextDescription":"The author of the spreadsheet, if available.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for spreadsheet media items.","plainTextDescription":"Metadata for spreadsheet media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts metadata from video as text/JSON.","plainTextDescription":"Extracts metadata from video as text/JSON.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ColorInterpretation"},"type":{"type":"enum","enum":{"values":["UNDEFINED","GRAY","PALETTE_INDEX","RED","GREEN","BLUE","ALPHA","HUE","SATURATION","LIGHTNESS","CYAN","MAGENTA","YELLOW","BLACK","Y_CB_CR_SPACE_Y","Y_CB_CR_SPACE_CB","Y_CB_CR_SPACE_CR"]}},"safety":"SAFE","documentation":{"description":"The color interpretation of a band.","plainTextDescription":"The color interpretation of a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelOperation"},"type":{"type":"object","object":{"properties":{"encodeFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"channel":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The channel number to select.","plainTextDescription":"The channel number to select.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Selects a specific channel from multi-channel audio.","plainTextDescription":"Selects a specific channel from multi-channel audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CropImageOperation"},"type":{"type":"object","object":{"properties":{"xOffset":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The x offset in pixels from the left hand side of the image.","plainTextDescription":"The x offset in pixels from the left hand side of the image.","example":[]}},"yOffset":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The y offset in pixels from the top of the image.","plainTextDescription":"The y offset in pixels from the top of the image.","example":[]}},"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The width of the cropping box in pixels.","plainTextDescription":"The width of the cropping box in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The height of the cropping box in pixels.","plainTextDescription":"The height of the cropping box in pixels.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Crops an image to a rectangular sub-window.","plainTextDescription":"Crops an image to a rectangular sub-window.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CadDecodeFormat"},"type":{"type":"enum","enum":{"values":["STEP"]}},"safety":"SAFE","documentation":{"description":"The format of a CAD media item.","plainTextDescription":"The format of a CAD media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ResizeToFitBoundingBoxOperation"},"type":{"type":"object","object":{"properties":{"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The width of the bounding box in pixels.","plainTextDescription":"The width of the bounding box in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The height of the bounding box in pixels.","plainTextDescription":"The height of the bounding box in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Resizes an image to maximally fit within a bounding box while preserving aspect ratio.\n","plainTextDescription":"Resizes an image to maximally fit within a bounding box while preserving aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GenerateEmbeddingOperation"},"type":{"type":"object","object":{"properties":{"modelId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AvailableEmbeddingModelIds"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Generates a vector embedding for an image using the specified model.","plainTextDescription":"Generates a vector embedding for an image using the specified model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Operation"},"type":{"type":"object","object":{"properties":{"pageRange":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PageRange"}}}}},"safety":"SAFE","documentation":{"example":[]}},"config":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint.\nThis only supports PDFs.\n","plainTextDescription":"Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint.\nThis only supports PDFs.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"pages":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The number of pages in the document.","plainTextDescription":"The number of pages in the document.","example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"title":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The title of the document, if available.","plainTextDescription":"The title of the document, if available.","example":[]}},"author":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The author of the document, if available.","plainTextDescription":"The author of the document, if available.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for document media items.","plainTextDescription":"Metadata for document media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mp4":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mp4VideoContainerFormat"}}}},"mov":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MovVideoContainerFormat"}}}},"mkv":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MkvVideoContainerFormat"}}}},"ts":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TsVideoContainerFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding video.","plainTextDescription":"The output format for encoding video.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobStatus"},"type":{"type":"enum","enum":{"values":["PENDING","FAILED","SUCCESSFUL"]}},"safety":"SAFE","documentation":{"description":"The status of a transformation job.","plainTextDescription":"The status of a transformation job.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CadMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CadDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"units":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CadUnits"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for CAD media items.","plainTextDescription":"Metadata for CAD media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts audio from video.","plainTextDescription":"Extracts audio from video.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastImageOperation"},"type":{"type":"object","object":{"properties":{"contrastType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Applies contrast adjustments to an image.","plainTextDescription":"Applies contrast adjustments to an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"transcribe":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscribeOperation"}}}},"waveform":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"WaveformOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for audio to text conversion.","plainTextDescription":"The operation to perform for audio to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Transformation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"emailToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextTransformation"}}}},"image":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageTransformation"}}}},"spreadsheetToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextTransformation"}}}},"videoToAudio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioTransformation"}}}},"audioToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextTransformation"}}}},"emailToAttachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentTransformation"}}}},"videoToArchive":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveTransformation"}}}},"videoToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextTransformation"}}}},"imageToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextTransformation"}}}},"videoToImage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageTransformation"}}}},"video":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoTransformation"}}}},"imageToDocument":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentTransformation"}}}},"dicomToImage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageTransformation"}}}},"documentToDocument":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentTransformation"}}}},"documentToImage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageTransformation"}}}},"imageToEmbedding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingTransformation"}}}},"audio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioTransformation"}}}},"documentToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextTransformation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A transformation to apply to a media item. Each variant specifies the type of transformation\nand any parameters required for the operation.\n","plainTextDescription":"A transformation to apply to a media item. Each variant specifies the type of transformation\nand any parameters required for the operation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"pdf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PdfFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding documents.","plainTextDescription":"The output format for encoding documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"A resource identifier that identifies a branch of a media set.\n","plainTextDescription":"A resource identifier that identifies a branch of a media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MailboxOrGroup"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mailbox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MailboxWrapper"}}}},"group":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GroupWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Either a mailbox or a group of mailboxes.","plainTextDescription":"Either a mailbox or a group of mailboxes.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CropConfig"},"type":{"type":"object","object":{"properties":{"tablePrompt":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Prompt for table extraction.","plainTextDescription":"Prompt for table extraction.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for table cropping.","plainTextDescription":"Configuration for table cropping.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionPreprocessingConfig"},"type":{"type":"object","object":{"properties":{"transformationConfig":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cropConfig":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CropConfig"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for layout-aware extraction preprocessing.","plainTextDescription":"Configuration for layout-aware extraction preprocessing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"JpgFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"JPEG image format.","plainTextDescription":"JPEG image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioSpecification"},"type":{"type":"object","object":{"properties":{"bitRate":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second.\n","plainTextDescription":"Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second.","example":[]}},"durationSeconds":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"Approximate duration of the audio, in seconds with up to two decimal digits (rounded up).\n","plainTextDescription":"Approximate duration of the audio, in seconds with up to two decimal digits (rounded up).","example":[]}},"numberOfChannels":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Number of audio channels in the audio stream.","plainTextDescription":"Number of audio channels in the audio stream.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Technical specifications for audio media items.","plainTextDescription":"Technical specifications for audio media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Config"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TextOutputFormat"}}}}},"safety":"SAFE","documentation":{"example":[]}},"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"}}}}},"safety":"UNSAFE","documentation":{"description":"List of OCR languages or scripts to use.","plainTextDescription":"List of OCR languages or scripts to use.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for v2 layout-aware document text extraction.","plainTextDescription":"Configuration for v2 layout-aware document text extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractAudioOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts the first audio stream from the video unchanged.","plainTextDescription":"Extracts the first audio stream from the video unchanged.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageOcrOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Performs OCR (Optical Character Recognition) on an image.","plainTextDescription":"Performs OCR (Optical Character Recognition) on an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelLayout"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"numberOfChannels":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"NumberOfChannels"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The audio channel layout configuration.","plainTextDescription":"The audio channel layout configuration.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwarePreprocessingWrapper"},"type":{"type":"object","object":{"properties":{"layoutAware":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionPreprocessingConfig"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for layout-aware preprocessing.","plainTextDescription":"Wrapper for layout-aware preprocessing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"language":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageWrapper"}}}},"script":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrScriptWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Either a specific language or a script for OCR.","plainTextDescription":"Either a specific language or a script for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PaletteInterpretation"},"type":{"type":"enum","enum":{"values":["GRAY","RGB","RGBA","CMYK","HLS"]}},"safety":"SAFE","documentation":{"description":"The palette interpretation of a band.","plainTextDescription":"The palette interpretation of a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastRayleigh"},"type":{"type":"object","object":{"properties":{"sigma":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The scaling parameter for the Rayleigh distribution (0-1).","plainTextDescription":"The scaling parameter for the Rayleigh distribution (0-1).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Applies Rayleigh distribution-based contrast adjustment.","plainTextDescription":"Applies Rayleigh distribution-based contrast adjustment.","example":[]}}],"errors":[{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmError"},"errorType":"INVALID_ARGUMENT","parameters":{"underlyingErrorType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"code":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A language model call failed during a media transformation.","plainTextDescription":"A language model call failed during a media transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationModelContextWindowExceeded"},"errorType":"INVALID_ARGUMENT","parameters":{"inputTokenCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxTokens":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The transformation input exceeded the model's maximum context window.","plainTextDescription":"The transformation input exceeded the model's maximum context window.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmPageRangeRequired"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set.\n","plainTextDescription":"Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConflictingMediaSetIdentifiers"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Client provided more than one of branch name, branch rid, or view rid as arguments. Only one may be specified.\n","plainTextDescription":"Client provided more than one of branch name, branch rid, or view rid as arguments. Only one may be specified.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSetOpenTransactionAlreadyExists"},"errorType":"CONFLICT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A transaction is already open on this media set and branch. A branch of a media set can only have one open transaction at a time.\n","plainTextDescription":"A transaction is already open on this media set and branch. A branch of a media set can only have one open transaction at a time.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"InvalidMediaItemRid"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}},"reason":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"invalidFieldName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"expectedFieldValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"actualFieldValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided media item RID is invalid.","plainTextDescription":"The provided media item RID is invalid.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemNotFound"},"errorType":"NOT_FOUND","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested media item could not be found, or the client token does not have access to it.","plainTextDescription":"The requested media item could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationDocumentExtractError"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error.\n","plainTextDescription":"Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TemporaryMediaUploadUnknownFailure"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"An unknown error occurred, please try again, and if this continues please contact your Palantir representative.\n","plainTextDescription":"An unknown error occurred, please try again, and if this continues please contact your Palantir representative.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationImageTooLargeForOcr"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The image or document page dimensions exceeded the maximum supported by the OCR model.","plainTextDescription":"The image or document page dimensions exceeded the maximum supported by the OCR model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UnexpectedMetadataType"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API.\n","plainTextDescription":"Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemImageUnparsable"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file cannot be parsed as an image.","plainTextDescription":"The file cannot be parsed as an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"InvalidMediaItemSchema"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media item does not match the schema of the media set.","plainTextDescription":"The media item does not match the schema of the media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationInvalidPageRange"},"errorType":"INVALID_ARGUMENT","parameters":{"startPageInclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"endPageExclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"documentLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The supplied page range is invalid.","plainTextDescription":"The supplied page range is invalid.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmLayoutModelFailure"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"The layout or OCR model used as preprocessing for document extraction failed.","plainTextDescription":"The layout or OCR model used as preprocessing for document extraction failed.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationModelNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"modelId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested model is not supported for this transformation.","plainTextDescription":"The requested model is not supported for this transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemRidByPathPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The token does not have permission to view paths in this media set.","plainTextDescription":"The token does not have permission to view paths in this media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSetNotFound"},"errorType":"NOT_FOUND","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested media set could not be found, or the client token does not have access to it.","plainTextDescription":"The requested media set could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MissingMediaItemContent"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file has no bytes.","plainTextDescription":"The file has no bytes.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"underlyingErrorType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"code":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The caller does not have permission to run this media transformation.","plainTextDescription":"The caller does not have permission to run this media transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmResponseParseError"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"The model response could not be parsed during document extraction.","plainTextDescription":"The model response could not be parsed during document extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationNotFound"},"errorType":"NOT_FOUND","parameters":{},"documentation":{"description":"The requested transformation could not be found.","plainTextDescription":"The requested transformation could not be found.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemXmlUnparsable"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaItemXmlFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaItemXmlFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The document cannot be parsed due to an unrecognized XML structure.","plainTextDescription":"The document cannot be parsed due to an unrecognized XML structure.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MissingMediaItemPath"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given media set requires paths but no path was provided.","plainTextDescription":"The given media set requires paths but no path was provided.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemIsPasswordProtected"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file cannot be read because it is password protected.","plainTextDescription":"The file cannot be read because it is password protected.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationInputTooLarge"},"errorType":"REQUEST_ENTITY_TOO_LARGE","parameters":{},"documentation":{"description":"The transformation input is too large for the underlying model.","plainTextDescription":"The transformation input is too large for the underlying model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemHasUnsupportedSecuritySettings"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file cannot be read because it contains unsupported security settings (for example, public-key security handlers in a PDF).","plainTextDescription":"The file cannot be read because it contains unsupported security settings (for example, public-key security handlers in a PDF).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TemporaryMediaUploadInsufficientPermissions"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Insufficient permissions to use this endpoint. This may be because that you are using a custom client instead of\nan official Palantir client library. If so, please try again using OSDK, Python Functions, or TypeScript\nFunctions V2.\n","plainTextDescription":"Insufficient permissions to use this endpoint. This may be because that you are using a custom client instead of\nan official Palantir client library. If so, please try again using OSDK, Python Functions, or TypeScript\nFunctions V2.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformedMediaItemNotFound"},"errorType":"NOT_FOUND","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested media item could not be found, or the client token does not have access to it.","plainTextDescription":"The requested media item could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationUnavailable"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested transformation is not currently available.","plainTextDescription":"The requested transformation is not currently available.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmMultiPageRequestUnsupported"},"errorType":"INVALID_ARGUMENT","parameters":{"requestedPages":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxValidPageCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Document extraction only supports a single page per request.","plainTextDescription":"Document extraction only supports a single page per request.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UnsupportedMetadata"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"A media item has an unsupported metadata type","plainTextDescription":"A media item has an unsupported metadata type","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemRidAlreadyExists"},"errorType":"CONFLICT","parameters":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A media item with the specified RID already exists.","plainTextDescription":"A media item with the specified RID already exists.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationModelNotAvailable"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested model is not available or the caller does not have permission to use it.","plainTextDescription":"The requested model is not available or the caller does not have permission to use it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationMediaSizeExceeded"},"errorType":"REQUEST_ENTITY_TOO_LARGE","parameters":{"sizeInBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"long","long":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxSizeInBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"long","long":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The media item exceeds the maximum size supported by the transformation.","plainTextDescription":"The media item exceeds the maximum size supported by the transformation.","example":[]}}]}; +export const MediaSetsV2: Namespace = {"name":"MediaSets","version":"v2","outputAuditVersions":"V3_ONLY","resources":[{"singleton":false,"documentation":{"description":"A media set is a representation of media data in Foundry. For more information, refer to the [media sets](/docs/foundry/data-integration/media-sets/) user documentation.\n","example":[]},"component":{"namespaceName":"MediaSets","localName":"MediaSet"},"pluralName":"MediaSets","operations":[{"name":"abortMediaTransaction","verb":"abort","documentation":{"description":"Aborts an open transaction. Items uploaded to the media set during this transaction will be deleted.\n","plainTextDescription":"Aborts an open transaction. Items uploaded to the media set during this transaction will be deleted.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/transactions/{transactionId}/abort","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"calculateImageMediaItemThumbnail","verb":"calculate","documentation":{"description":"Starts calculation of a thumbnail for a given image.\n","plainTextDescription":"Starts calculation of a thumbnail for a given image.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform/imagery/thumbnail/calculate","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Status of the thumbnail calculation. Type will be 'successful' if the thumbnail is available, \n'pending' if the thumbnail is being calculated, and 'failed' if there was an error.\n","plainTextDescription":"Status of the thumbnail calculation. Type will be 'successful' if the thumbnail is available,\n'pending' if the thumbnail is being calculated, and 'failed' if there was an error.","example":[{"type":"successful"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"clearMediaItemAtPath","verb":"clear","documentation":{"description":"Clears (soft-deletes) the media item at the specified path within a media set, making it and all older\nmedia items at that path un-retrievable.\n\nA branch name, branch RID, or view RID may optionally be specified. If none is specified,\nthe item will be cleared from the default branch. If more than one is specified, an error is thrown.\n\nFor transactional media sets, a transaction ID must be provided. The deletion will not be\nvisible until the transaction is committed.\n","plainTextDescription":"Clears (soft-deletes) the media item at the specified path within a media set, making it and all older\nmedia items at that path un-retrievable.\nA branch name, branch RID, or view RID may optionally be specified. If none is specified,\nthe item will be cleared from the default branch. If more than one is specified, an error is thrown.\nFor transactional media sets, a transaction ID must be provided. The deletion will not be\nvisible until the transaction is committed.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataDelete"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/clearAtPath","httpMethod":"DELETE","parameters":[{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"The path of the media item to clear.\n","plainTextDescription":"The path of the media item to clear.","example":["q3-data%2fmy-file.png"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided.","plainTextDescription":"Specifies the specific branch by name from which this media item will be cleared. May not be provided if branch rid or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchRid","documentation":{"description":"Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided.","plainTextDescription":"Specifies the specific branch by rid from which this media item will be cleared. May not be provided if branch name or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided.","plainTextDescription":"Specifies the specific view by rid from which this media item will be cleared. May not be provided if branch name or branch rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of the transaction associated with this request. Required if this is a transactional media set.\n","plainTextDescription":"The ID of the transaction associated with this request. Required if this is a transactional media set.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Media item cleared successfully.","plainTextDescription":"Media item cleared successfully.","example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"commitMediaTransaction","verb":"commit","documentation":{"description":"Commits an open transaction. On success, items uploaded to the media set during this transaction will become available.\n","plainTextDescription":"Commits an open transaction. On success, items uploaded to the media set during this transaction will become available.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/transactions/{transactionId}/commit","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"createMediaTransaction","verb":"create","documentation":{"description":"Creates a new transaction. Items uploaded to the media set while this transaction is open will not be reflected until the transaction is committed.\n","plainTextDescription":"Creates a new transaction. Items uploaded to the media set while this transaction is open will not be reflected until the transaction is committed.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/transactions","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"The branch on which to open the transaction. Defaults to `master` for most enrollments.\n","plainTextDescription":"The branch on which to open the transaction. Defaults to master for most enrollments.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"transactionId":"550e8400-e29b-41d4-a716-446655440000"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemInfo","verb":"info","documentation":{"description":"Gets information about the media item.\n","plainTextDescription":"Gets information about the media item.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"viewRid":"ri.mio.main.view.1","logicalTimestamp":12345,"path":"example.png","attribution":{"creatorId":1,"creationTimestamp":"2020-07-10 15:00:00.000"},"originallyUploadedFileMimeType":"image/png"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemInfoResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemMetadata","verb":"metadata","documentation":{"description":"Gets detailed metadata about the media item, including type-specific information\nsuch as dimensions for images, duration for audio/video, page count for documents, etc.\n","plainTextDescription":"Gets detailed metadata about the media item, including type-specific information\nsuch as dimensions for images, duration for audio/video, page count for documents, etc.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"type":"imagery","format":"PNG","dimensions":{"width":1920,"height":1080},"sizeBytes":2048576}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaItemMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemReference","verb":"reference","documentation":{"description":"Gets the [media reference](/docs/foundry/data-integration/media-sets/#media-references) for this media item.\n","plainTextDescription":"Gets the media reference for this media item.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReference"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaItemRidByPath","verb":"getRidByPath","documentation":{"description":"Returns the media item RID for the media item with the specified path.\n","plainTextDescription":"Returns the media item RID for the media item with the specified path.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/getRidByPath","httpMethod":"GET","parameters":[{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"The path of the media item.\n","plainTextDescription":"The path of the media item.","example":[]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name in which to search for this media item. May not be provided if branch rid or view rid are provided.","plainTextDescription":"Specifies the specific branch by name in which to search for this media item. May not be provided if branch rid or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchRid","documentation":{"description":"Specifies the specific branch by rid in which to search for this media item. May not be provided if branch name or view rid are provided.","plainTextDescription":"Specifies the specific branch by rid in which to search for this media item. May not be provided if branch name or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid in which to search for this media item. May not be provided if branch name or branch rid are provided.","plainTextDescription":"Specifies the specific view by rid in which to search for this media item. May not be provided if branch name or branch rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemRidByPathResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaSet","verb":"get","documentation":{"description":"Gets information about the media set.\n","plainTextDescription":"Gets information about the media set.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}","httpMethod":"GET","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetMediaSetResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getTransformationJobResult","verb":"getResult","documentation":{"description":"Gets the result of a completed transformation job. Returns the transformed media content as binary data.\nThis endpoint will return an error if the transformation job has not completed successfully.\n","plainTextDescription":"Gets the result of a completed transformation job. Returns the transformed media content as binary data.\nThis endpoint will return an error if the transformation job has not completed successfully.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-transform"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}/result","httpMethod":"GET","parameters":[{"name":"Token","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transformationJobId","documentation":{"description":"The ID of the transformation job.\n","plainTextDescription":"The ID of the transformation job.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The transformed media content.","plainTextDescription":"The transformed media content.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getTransformationJobStatus","verb":"getStatus","documentation":{"description":"Gets the status of a transformation job.\n","plainTextDescription":"Gets the status of a transformation job.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-transform"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}","httpMethod":"GET","parameters":[{"name":"Token","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transformationJobId","documentation":{"description":"The ID of the transformation job.\n","plainTextDescription":"The ID of the transformation job.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The status of the transformation job.","plainTextDescription":"The status of the transformation job.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetTransformationJobStatusResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"putMediaItem","verb":"upload","documentation":{"description":"Uploads a media item to an existing media set.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\nA branch name, or branch rid, or view rid may optionally be specified. If none is specified, the item will be uploaded to the default branch. If more than one is specified, an error is thrown.\n","plainTextDescription":"Uploads a media item to an existing media set.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.\nA branch name, or branch rid, or view rid may optionally be specified. If none is specified, the item will be uploaded to the default branch. If more than one is specified, an error is thrown.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"An identifier for a media item within a media set. Necessary if the backing media set requires paths.","plainTextDescription":"An identifier for a media item within a media set. Necessary if the backing media set requires paths.","example":["q3-data%2fmy-file.png"]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name to which this media item will be uploaded. May not be provided if branch rid or view rid are provided.","plainTextDescription":"Specifies the specific branch by name to which this media item will be uploaded. May not be provided if branch rid or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branchRid","documentation":{"description":"Specifies the specific branch by rid to which this media item will be uploaded. May not be provided if branch name or view rid are provided.","plainTextDescription":"Specifies the specific branch by rid to which this media item will be uploaded. May not be provided if branch name or view rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.","plainTextDescription":"Specifies the specific view by rid to which this media item will be uploaded. May not be provided if branch name or branch rid are provided.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The id of the transaction associated with this request. Required if this is a transactional media set.\n","plainTextDescription":"The id of the transaction associated with this request. Required if this is a transactional media set.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of `ri.mio..media-item.`, where `` is the same as \nthe instance part of the media set RID, and `` is a UUID.\nAn `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format.\nA `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\n","plainTextDescription":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of ri.mio..media-item., where is the same as\nthe instance part of the media set RID, and is a UUID.\nAn InvalidMediaItemRid error will be thrown if the RID is not in the expected format.\nA MediaItemRidAlreadyExists error will be thrown if the media set already contains a media item with the same RID.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PutMediaItemResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"readMediaItem","verb":"read","documentation":{"description":"Gets the content of a media item.\n","plainTextDescription":"Gets the content of a media item.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The content stream.","plainTextDescription":"The content stream.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"readOriginalMediaItem","verb":"readOriginal","documentation":{"description":"Gets the content of an original file uploaded to the media item, even if it was transformed on upload due to being an additional input format.\n","plainTextDescription":"Gets the content of an original file uploaded to the media item, even if it was transformed on upload due to being an additional input format.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The content stream.","plainTextDescription":"The content stream.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"registerMediaItem","verb":"register","documentation":{"description":"Registers a media item that currently resides in a federated media store. Registration will validate the item\nagainst the media set's schema and perform initial metadata extraction.\nThis endpoint is only applicable for federated media sets.\n","plainTextDescription":"Registers a media item that currently resides in a federated media store. Registration will validate the item\nagainst the media set's schema and perform initial metadata extraction.\nThis endpoint is only applicable for federated media sets.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/register","httpMethod":"POST","parameters":[{"name":"mediaSetRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branchName","documentation":{"description":"Specifies the specific branch by name to which this media item will be registered.","plainTextDescription":"Specifies the specific branch by name to which this media item will be registered.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"viewRid","documentation":{"description":"Specifies the specific view by rid to which this media item will be registered.","plainTextDescription":"Specifies the specific view by rid to which this media item will be registered.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The id of the transaction associated with this request. Required for transactional media sets.","plainTextDescription":"The id of the transaction associated with this request. Required for transactional media sets.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"","plainTextDescription":"","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"retrieveImageMediaItemThumbnail","verb":"retrieve","documentation":{"description":"Retrieves a successfully calculated thumbnail for a given image.\n\nThumbnails are 200px wide in the format of `image/webp`\n","plainTextDescription":"Retrieves a successfully calculated thumbnail for a given image.\nThumbnails are 200px wide in the format of image/webp","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-read"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform/imagery/thumbnail/retrieve","httpMethod":"GET","parameters":[{"name":"ReadToken","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Retrieves the thumbnail of an image (if available).\n","plainTextDescription":"Retrieves the thumbnail of an image (if available).","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"transformMediaItem","verb":"transform","documentation":{"description":"Initiates a transformation on a media item. Returns a job ID that can be used to check the status and retrieve \nthe result of the transformation.\n\nTransforming a media item requires that you are able to read the media item, either via `api:mediasets-read` or\nvia a `MediaItemReadToken`\n","plainTextDescription":"Initiates a transformation on a media item. Returns a job ID that can be used to check the status and retrieve\nthe result of the transformation.\nTransforming a media item requires that you are able to read the media item, either via api:mediasets-read or\nvia a MediaItemReadToken","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:mediasets-transform"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform","httpMethod":"POST","parameters":[{"name":"Token","documentation":{"example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemReadToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"Attribution","documentation":{"description":"Optional resource to attribute LLM calls on behalf of.","plainTextDescription":"Optional resource to attribute LLM calls on behalf of.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaSetRid","documentation":{"description":"The RID of the media set.\n","plainTextDescription":"The RID of the media set.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"The RID of the media item.\n","plainTextDescription":"The RID of the media item.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"transformation":{"type":"image","encoding":{"type":"webp"},"operations":[{"type":"resize","width":800,"height":600}]}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"The transformation was initiated successfully.","plainTextDescription":"The transformation was initiated successfully.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"uploadMedia","verb":"uploadMedia","documentation":{"description":"Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted. \n\nIf multiple resources are attributed to, usage will be attributed to the first one in the list.\n\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\nThird-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read api:ontologies-write`.\n","plainTextDescription":"Uploads a temporary media item. If the media item isn't persisted within 1 hour, the item will be deleted.\nIf multiple resources are attributed to, usage will be attributed to the first one in the list.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.\nThird-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-write.","example":[]},"releaseStage":"STABLE","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/mediasets/media/upload","httpMethod":"PUT","parameters":[{"name":"attribution","documentation":{"description":"used for passing through usage attribution","plainTextDescription":"used for passing through usage attribution","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"A user-defined label for a media item within a media set. Required if the backing media set requires paths. \nUploading multiple files to the same path will result in only the most recent file being associated with the \npath.\n","plainTextDescription":"A user-defined label for a media item within a media set. Required if the backing media set requires paths.\nUploading multiple files to the same path will result in only the most recent file being associated with the\npath.","example":["my-file.png"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaItemRid","documentation":{"description":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of `ri.mio..media-item.`, where `` is the same as \nthe instance part of the media set RID, and `` is a UUID.\nAn `InvalidMediaItemRid` error will be thrown if the RID is not in the expected format.\nA `MediaItemRidAlreadyExists` error will be thrown if the media set already contains a media item with the same RID.\n","plainTextDescription":"An optional RID to use for the media item to create. If omitted, the server will automatically generate a\nRID. In most cases, the server-generated RID should be preferred; only specify a custom RID if your\nworkflow strictly requires deterministic or client-controlled identifiers.\nThe RID must be in the format of ri.mio..media-item., where is the same as\nthe instance part of the media set RID, and is a UUID.\nAn InvalidMediaItemRid error will be thrown if the RID is not in the expected format.\nA MediaItemRidAlreadyExists error will be thrown if the media set already contains a media item with the same RID.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"The media reference for the uploaded media.","plainTextDescription":"The media reference for the uploaded media.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReference"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]}],"components":[{"locator":{"namespaceName":"MediaSets","localName":"MediaAttribution"},"type":{"type":"object","object":{"properties":{"creatorId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"example":[]}},"creationTimestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"The timestamp when the media item was created, in ISO 8601 timestamp format.","plainTextDescription":"The timestamp when the media item was created, in ISO 8601 timestamp format.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"getEmailBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetEmailBodyOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for email to text extraction.","plainTextDescription":"The operation to perform for email to text extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractSceneFrames":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractSceneFramesOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to archive conversion.","plainTextDescription":"The operation to perform for video to archive conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BranchName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and \n(c) not a valid ResourceIdentifier.\n","plainTextDescription":"A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and\n(c) not a valid ResourceIdentifier.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Orientation"},"type":{"type":"object","object":{"properties":{"rotationAngle":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RotationAngle"}}}}},"safety":"SAFE","documentation":{"example":[]}},"flipAxis":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"FlipAxis"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The orientation information as encoded in EXIF metadata.","plainTextDescription":"The orientation information as encoded in EXIF metadata.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts text content from email.","plainTextDescription":"Extracts text content from email.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetEmailAttachmentOperation"},"type":{"type":"object","object":{"properties":{"mimeType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The MIME type of the attachment. Must match the metadata attachment MIME type.\n","plainTextDescription":"The MIME type of the attachment. Must match the metadata attachment MIME type.","example":[]}},"attachmentIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The attachment index.","plainTextDescription":"The attachment index.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Retrieves the bytes of an email attachment by index.","plainTextDescription":"Retrieves the bytes of an email attachment by index.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"WavEncodeFormat"},"type":{"type":"object","object":{"properties":{"sampleRate":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The sample rate in Hz. Defaults to 44100 Hz if not specified.","plainTextDescription":"The sample rate in Hz. Defaults to 44100 Hz if not specified.","example":[]}},"audioChannelLayout":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelLayout"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"WAV audio format with optional sample rate and channel layout.","plainTextDescription":"WAV audio format with optional sample rate and channel layout.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextFromPagesToArrayOperation"},"type":{"type":"object","object":{"properties":{"startPage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed start page. Defaults to the first page if not specified.","plainTextDescription":"The zero-indexed start page. Defaults to the first page if not specified.","example":[]}},"endPage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed end page (inclusive). Defaults to the last page if not specified.","plainTextDescription":"The zero-indexed end page (inclusive). Defaults to the last page if not specified.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts text from multiple pages into a list of strings.","plainTextDescription":"Extracts text from multiple pages into a list of strings.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationSuccessfulResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"WebpFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"WebP image format.","plainTextDescription":"WebP image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"NumberOfChannels"},"type":{"type":"object","object":{"properties":{"numberOfChannels":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The number of audio channels.","plainTextDescription":"The number of audio channels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specifies the number of audio channels. Defaults to 2 (stereo).","plainTextDescription":"Specifies the number of audio channels. Defaults to 2 (stereo).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextPreprocessingWrapper"},"type":{"type":"object","object":{"properties":{"extractText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for text extraction preprocessing.","plainTextDescription":"Wrapper for text extraction preprocessing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CreatePdfOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Converts an image to a PDF document.","plainTextDescription":"Converts an image to a PDF document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageExtractLayoutAwareContentOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionParameters"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts text from an image with layout information preserved.","plainTextDescription":"Extracts text from an image with layout information preserved.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomDataElementKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The key of a DICOM data element.","plainTextDescription":"The key of a DICOM data element.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Model3dType"},"type":{"type":"enum","enum":{"values":["POINT_CLOUD","MESH"]}},"safety":"SAFE","documentation":{"description":"The type of 3D model representation.","plainTextDescription":"The type of 3D model representation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms audio media items.","plainTextDescription":"Transforms audio media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AnnotateImageOperation"},"type":{"type":"object","object":{"properties":{"annotations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Annotation"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of annotations to draw on the image.","plainTextDescription":"The list of annotations to draw on the image.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Annotates an image with bounding boxes, labels, and colors.","plainTextDescription":"Annotates an image with bounding boxes, labels, and colors.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LanguageModelLocator"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ApiNameLocatorWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Locator for identifying a language model.","plainTextDescription":"Locator for identifying a language model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"slicePdfRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SlicePdfRangeOperation"}}}},"convertDocument":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ConvertDocumentOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for document to document conversion.","plainTextDescription":"The operation to perform for document to document conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSchema"},"type":{"type":"enum","enum":{"values":["AUDIO","CAD","DICOM","DOCUMENT","IMAGERY","MODEL_3D","MULTIMODAL","SPREADSHEET","STREAMING_VIDEO","TILED_RASTER","VIDEO","EMAIL"]}},"safety":"SAFE","documentation":{"description":"The schema type of a media set, indicating what type of media items it can contain.","plainTextDescription":"The schema type of a media set, indicating what type of media items it can contain.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageOperation"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of operations to apply to the image, in order.","plainTextDescription":"The list of operations to apply to the image, in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms images with multiple operations applied in sequence.\nOperations are applied in the order they appear in the list.\n","plainTextDescription":"Transforms images with multiple operations applied in sequence.\nOperations are applied in the order they appear in the list.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailAttachment"},"type":{"type":"object","object":{"properties":{"attachmentIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The index of the attachment in the email.","plainTextDescription":"The index of the attachment in the email.","example":[]}},"fileName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The file name of the attachment, if available.","plainTextDescription":"The file name of the attachment, if available.","example":[]}},"mimeType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The verified MIME type of the attachment.","plainTextDescription":"The verified MIME type of the attachment.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an email attachment.","plainTextDescription":"Metadata about an email attachment.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransactionPolicy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"batchTransactions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BatchTransactionsTransactionPolicy"}}}},"noTransactions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"NoTransactionsTransactionPolicy"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The transaction policy for a media set, determining how writes are handled.\n","plainTextDescription":"The transaction policy for a media set, determining how writes are handled.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VlmOutputFormat"},"type":{"type":"enum","enum":{"values":["MARKDOWN"]}},"safety":"SAFE","documentation":{"description":"Format in which to return text extracted by vision language models.","plainTextDescription":"Format in which to return text extracted by vision language models.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Pttml"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"PTTML (Palantir Timed Text Markup Language) transcription output format.","plainTextDescription":"PTTML (Palantir Timed Text Markup Language) transcription output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RenderImageLayerOperation"},"type":{"type":"object","object":{"properties":{"layerNumber":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The layer number to render. If not specified, renders the middle layer.\n","plainTextDescription":"The layer number to render. If not specified, renders the middle layer.","example":[]}},"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Renders a frame of a DICOM file as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Renders a frame of a DICOM file as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractTableOfContentsOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts the table of contents from a document.","plainTextDescription":"Extracts the table of contents from a document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UnitInterpretation"},"type":{"type":"object","object":{"properties":{"unit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"scale":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"offset":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The unit interpretation for a band.","plainTextDescription":"The unit interpretation for a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"equalize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastEqualize"}}}},"rayleigh":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastRayleigh"}}}},"binarize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastBinarize"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The type of contrast adjustment to apply.","plainTextDescription":"The type of contrast adjustment to apply.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractTableOfContents":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractTableOfContentsOperation"}}}},"getPdfPageDimensions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetPdfPageDimensionsOperation"}}}},"extractAllText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractAllTextOperation"}}}},"extractVlmText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractVlmTextOperation"}}}},"extractTextFromPagesToArray":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextFromPagesToArrayOperation"}}}},"ocrOnPage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPageOperation"}}}},"extractFormFields":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractFormFieldsOperation"}}}},"extractLayoutAwareTextV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Operation"}}}},"extractTextV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Operation"}}}},"extractUnstructuredTextFromPage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractUnstructuredTextFromPageOperation"}}}},"extractLayoutAwareContent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentExtractLayoutAwareContentOperation"}}}},"ocrOnPages":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPagesOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for document to text conversion.","plainTextDescription":"The operation to perform for document to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageRegionPolygon"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImagePixelCoordinate"}}}}},"safety":"SAFE","documentation":{"description":"Polygon drawn by connecting adjacent coordinates in the list with straight lines.\nA line is drawn between the last and first coordinates in the list to create a closed shape.\nUsed to define regions in an image for operations like encryption/decryption.\n","plainTextDescription":"Polygon drawn by connecting adjacent coordinates in the list with straight lines.\nA line is drawn between the last and first coordinates in the list to create a closed shape.\nUsed to define regions in an image for operations like encryption/decryption.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrOutputFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"hocr":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrHocrOutputFormat"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrTextOutputFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for OCR results.","plainTextDescription":"The output format for OCR results.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GroupWrapper"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Group"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A wrapper for a group in the MailboxOrGroup union.","plainTextDescription":"A wrapper for a group in the MailboxOrGroup union.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextEncodeFormat"},"type":{"type":"enum","enum":{"values":["TEXT","HTML"]}},"safety":"SAFE","documentation":{"description":"The output format for email body extraction.","plainTextDescription":"The output format for email body extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An identifier for a media item transformation job.\n","plainTextDescription":"An identifier for a media item transformation job.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GroundControlPoint"},"type":{"type":"object","object":{"properties":{"pixX":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The pixel X coordinate.","plainTextDescription":"The pixel X coordinate.","example":[]}},"pixY":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The pixel Y coordinate.","plainTextDescription":"The pixel Y coordinate.","example":[]}},"projX":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The projected X coordinate.","plainTextDescription":"The projected X coordinate.","example":[]}},"projY":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The projected Y coordinate.","plainTextDescription":"The projected Y coordinate.","example":[]}},"projZ":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"The projected Z coordinate.","plainTextDescription":"The projected Z coordinate.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A ground control point for geo-referencing.","plainTextDescription":"A ground control point for geo-referencing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"pending":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationPendingResponse"}}}},"failed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationFailedResponse"}}}},"successful":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationSuccessfulResponse"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetPdfPageDimensionsOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the dimensions of each page in a PDF document as JSON (in points).","plainTextDescription":"Returns the dimensions of each page in a PDF document as JSON (in points).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractFirstFrameOperation"},"type":{"type":"object","object":{"properties":{"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts the first full scene frame from the video.\nIf both width and height are not specified, preserves the original size.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Extracts the first full scene frame from the video.\nIf both width and height are not specified, preserves the original size.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationFailedResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConvertAudioOperation"},"type":{"type":"object","object":{"properties":{"encodeFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts audio to the specified format.","plainTextDescription":"Converts audio to the specified format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoDecodeFormat"},"type":{"type":"enum","enum":{"values":["MP4","MKV","MOV","TS","WEBM"]}},"safety":"SAFE","documentation":{"description":"The format of a video media item.","plainTextDescription":"The format of a video media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts video frames as images.","plainTextDescription":"Extracts video frames as images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscriptionLanguage"},"type":{"type":"enum","enum":{"values":["AF","AM","AR","AS","AZ","BA","BE","BG","BN","BO","BR","BS","CA","CS","CY","DA","DE","EL","EN","ES","ET","EU","FA","FI","FO","FR","GL","GU","HA","HAW","HE","HI","HR","HT","HU","HY","ID","IS","IT","JA","JW","KA","KK","KM","KN","KO","LA","LB","LN","LO","LT","LV","MG","MI","MK","ML","MN","MR","MS","MT","MY","NE","NL","NN","NO","OC","PA","PL","PS","PT","RO","RU","SA","SD","SI","SK","SL","SN","SO","SQ","SR","SU","SV","SW","TA","TE","TG","TH","TK","TL","TR","TT","UK","UR","UZ","VI","YI","YO","YUE","ZH","AFRIKAANS","ALBANIAN","AMHARIC","ARABIC","ARMENIAN","ASSAMESE","AZERBAIJANI","BASHKIR","BASQUE","BELARUSIAN","BENGALI","BOSNIAN","BRETON","BULGARIAN","BURMESE","CANTONESE","CASTILIAN","CATALAN","CHINESE","CROATIAN","CZECH","DANISH","DUTCH","ENGLISH","ESTONIAN","FAROESE","FINNISH","FLEMISH","FRENCH","GALICIAN","GEORGIAN","GERMAN","GREEK","GUJARATI","HAITIAN","HAITIAN_CREOLE","HAUSA","HAWAIIAN","HEBREW","HINDI","HUNGARIAN","ICELANDIC","INDONESIAN","ITALIAN","JAPANESE","JAVANESE","KANNADA","KAZAKH","KHMER","KOREAN","LAO","LATIN","LATVIAN","LETZEBURGESCH","LINGALA","LITHUANIAN","LUXEMBOURGISH","MACEDONIAN","MALAGASY","MALAY","MALAYALAM","MALTESE","MANDARIN","MAORI","MARATHI","MOLDAVIAN","MOLDOVAN","MONGOLIAN","MYANMAR","NEPALI","NORWEGIAN","NYNORSK","OCCITAN","PANJABI","PASHTO","PERSIAN","POLISH","PORTUGUESE","PUNJABI","PUSHTO","ROMANIAN","RUSSIAN","SANSKRIT","SERBIAN","SHONA","SINDHI","SINHALA","SINHALESE","SLOVAK","SLOVENIAN","SOMALI","SPANISH","SUNDANESE","SWAHILI","SWEDISH","TAGALOG","TAJIK","TAMIL","TATAR","TELUGU","THAI","TIBETAN","TURKISH","TURKMEN","UKRAINIAN","URDU","UZBEK","VALENCIAN","VIETNAMESE","WELSH","YIDDISH","YORUBA"]}},"safety":"SAFE","documentation":{"description":"Language codes for audio transcription.\nIf not specified, the language will be auto-detected from the first 30 seconds of audio.\n","plainTextDescription":"Language codes for audio transcription.\nIf not specified, the language will be auto-detected from the first 30 seconds of audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CoordinateReferenceSystem"},"type":{"type":"object","object":{"properties":{"wkt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The Well-Known Text representation of the CRS.","plainTextDescription":"The Well-Known Text representation of the CRS.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The coordinate reference system for geo-referenced imagery.","plainTextDescription":"The coordinate reference system for geo-referenced imagery.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrMode"},"type":{"type":"enum","enum":{"values":["AUTO","ELECTRONIC","SCAN"]}},"safety":"SAFE","documentation":{"description":"OCR mode for document extraction.","plainTextDescription":"OCR mode for document extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionParameters"},"type":{"type":"object","object":{"properties":{"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguage"}}}}},"safety":"SAFE","documentation":{"description":"The languages to use for extraction.","plainTextDescription":"The languages to use for extraction.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Parameters for layout-aware content extraction.","plainTextDescription":"Parameters for layout-aware content extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"},"type":{"type":"object","object":{"properties":{"outputFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrOutputFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"}}}}},"safety":"UNSAFE","documentation":{"description":"The languages or scripts to use for OCR.","plainTextDescription":"The languages or scripts to use for OCR.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Parameters for OCR (Optical Character Recognition) operations.","plainTextDescription":"Parameters for OCR (Optical Character Recognition) operations.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Modality"},"type":{"type":"enum","enum":{"values":["AR","ASMT","AU","BDUS","BI","BMD","CR","CT","CTPROTOCOL","DG","DOC","DX","ECG","EPS","ES","FID","GM","HC","HD","IO","IOL","IVOCT","IVUS","KER","KO","LEN","LS","MG","MR","M3D","NM","OAM","OCT","OP","OPM","OPT","OPTBSV","OPTENF","OPV","OSS","OT","PLAN","PR","PT","PX","REG","RESP","RF","RG","RTDOSE","RTIMAGE","RTINTENT","RTPLAN","RTRAD","RTRECORD","RTSEGANN","RTSTRUCT","RWV","SEG","SM","SMR","SR","SRF","STAIN","TEXTUREMAP","TG","US","VA","XA","XC","AS","CD","CF","CP","CS","DD","DF","DM","DS","EC","FA","FS","LP","MA","MS","OPR","ST","VF"]}},"safety":"SAFE","documentation":{"description":"DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification. \nhttps://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1\n","plainTextDescription":"DICOM modality code. A list of modalities and their meanings can be found in the DICOM specification.\nhttps://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.7.3.html#sect_C.7.3.1.1.1","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpec"},"type":{"type":"object","object":{"properties":{"modelLocator":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LanguageModelLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"systemPrompt":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"System prompt for the LLM.","plainTextDescription":"System prompt for the LLM.","example":[]}},"userPrompt":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"User prompt for the LLM.","plainTextDescription":"User prompt for the LLM.","example":[]}},"maxTokens":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Maximum number of tokens per request to generate.","plainTextDescription":"Maximum number of tokens per request to generate.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Standard chat-based LLM specification with system and user prompts.","plainTextDescription":"Standard chat-based LLM specification with system and user prompts.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetTimestampsForSceneFramesOperation"},"type":{"type":"object","object":{"properties":{"sceneScore":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SceneScore"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns a list of timestamps for scene frames in the video as JSON.","plainTextDescription":"Returns a list of timestamps for scene frames in the video as JSON.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscribeTextEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"plainTextNoSegmentData":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PlainTextNoSegmentData"}}}},"json":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscribeJson"}}}},"pttml":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Pttml"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for transcription results.","plainTextDescription":"The output format for transcription results.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemResponse"},"type":{"type":"object","object":{"properties":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Response after successfully registering a media item.","plainTextDescription":"Response after successfully registering a media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EncryptImageOperation"},"type":{"type":"object","object":{"properties":{"polygons":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageRegionPolygon"}}}}},"safety":"SAFE","documentation":{"description":"The polygons defining the regions to encrypt.","plainTextDescription":"The polygons defining the regions to encrypt.","example":[]}},"cipherLicenseRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The resource identifier for the cipher license.","plainTextDescription":"The resource identifier for the cipher license.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Encrypts bounding boxes in an image using a commutative encryption algorithm.","plainTextDescription":"Encrypts bounding boxes in an image using a commutative encryption algorithm.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrScriptWrapper"},"type":{"type":"object","object":{"properties":{"script":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrScript"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Wrapper for an OCR script.","plainTextDescription":"Wrapper for an OCR script.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RotateImageOperation"},"type":{"type":"object","object":{"properties":{"angle":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RotationAngle"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Rotates an image clockwise by the specified angle.","plainTextDescription":"Rotates an image clockwise by the specified angle.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractUnstructuredTextFromPageOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The page number.","plainTextDescription":"The page number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts unstructured text from a specified page.","plainTextDescription":"Extracts unstructured text from a specified page.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PutMediaItemResponse"},"type":{"type":"object","object":{"properties":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms documents to documents.","plainTextDescription":"Transforms documents to documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TileImageOperation"},"type":{"type":"object","object":{"properties":{"zoom":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The zoom level of the tile.","plainTextDescription":"The zoom level of the tile.","example":[]}},"x":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The x coordinate of the tile.","plainTextDescription":"The x coordinate of the tile.","example":[]}},"y":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The y coordinate of the tile.","plainTextDescription":"The y coordinate of the tile.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Generates Slippy map tiles (EPSG 3857) from a geo-embedded image.\nOnly supported for geo-embedded TIFF and NITF images with at most 100M square pixels.\n","plainTextDescription":"Generates Slippy map tiles (EPSG 3857) from a geo-embedded image.\nOnly supported for geo-embedded TIFF and NITF images with at most 100M square pixels.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"createPdf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CreatePdfOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for image to document conversion.","plainTextDescription":"The operation to perform for image to document conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Group"},"type":{"type":"object","object":{"properties":{"groupName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the group.","plainTextDescription":"The name of the group.","example":[]}},"mailboxes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"}}}}},"safety":"UNSAFE","documentation":{"description":"The mailboxes in the group.","plainTextDescription":"The mailboxes in the group.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A named group of mailboxes.","plainTextDescription":"A named group of mailboxes.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RenderPageToFitBoundingBoxOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed page number to render. Defaults to the first page if not specified.","plainTextDescription":"The zero-indexed page number to render. Defaults to the first page if not specified.","example":[]}},"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The width of the bounding box in pixels.","plainTextDescription":"The width of the bounding box in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The height of the bounding box in pixels.","plainTextDescription":"The height of the bounding box in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Renders a PDF page to maximally fit within a bounding box while preserving aspect ratio.\n","plainTextDescription":"Renders a PDF page to maximally fit within a bounding box while preserving aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"jpg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"JpgFormat"}}}},"tiff":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TiffFormat"}}}},"png":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PngFormat"}}}},"webp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"WebpFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding imagery.","plainTextDescription":"The output format for encoding imagery.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscodeOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Encodes video to the specified format.","plainTextDescription":"Encodes video to the specified format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Config"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TextOutputFormat"}}}}},"safety":"SAFE","documentation":{"example":[]}},"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"}}}}},"safety":"UNSAFE","documentation":{"description":"List of OCR languages or scripts to use.","plainTextDescription":"List of OCR languages or scripts to use.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for v2 document text extraction.","plainTextDescription":"Configuration for v2 document text extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Renders DICOM (Digital Imaging and Communications in Medicine) files as images.","plainTextDescription":"Renders DICOM (Digital Imaging and Communications in Medicine) files as images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GpsMetadata"},"type":{"type":"object","object":{"properties":{"latitude":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"longitude":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"altitude":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"GPS location metadata extracted from EXIF data embedded in the image.","plainTextDescription":"GPS location metadata extracted from EXIF data embedded in the image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpecWrapper"},"type":{"type":"object","object":{"properties":{"chat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpec"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for chat-based LLM specification.","plainTextDescription":"Wrapper for chat-based LLM specification.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"channel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelOperation"}}}},"chunk":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioChunkOperation"}}}},"convert":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ConvertAudioOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform on audio.","plainTextDescription":"The operation to perform on audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GeoMetadata"},"type":{"type":"object","object":{"properties":{"crs":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CoordinateReferenceSystem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"geotransform":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AffineTransform"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gcpInfo":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GcpList"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gpsData":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GpsMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Embedded geo-referencing data for an image.","plainTextDescription":"Embedded geo-referencing data for an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ResizingMode"},"type":{"type":"enum","enum":{"values":["RESIZING","FIT_INTO_BOUNDING_BOX"]}},"safety":"SAFE","documentation":{"description":"Image resizing strategy.","plainTextDescription":"Image resizing strategy.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GcpList"},"type":{"type":"object","object":{"properties":{"gcps":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GroundControlPoint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A list of ground control points for geo-referencing.","plainTextDescription":"A list of ground control points for geo-referencing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ApiNameLocatorWrapper"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The API name of the language model.","plainTextDescription":"The API name of the language model.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Wrapper for API name-based model locator.","plainTextDescription":"Wrapper for API name-based model locator.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PerformanceMode"},"type":{"type":"enum","enum":{"values":["MORE_ECONOMICAL","MORE_PERFORMANT"]}},"safety":"SAFE","documentation":{"description":"The performance mode for transcription.","plainTextDescription":"The performance mode for transcription.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemRequest"},"type":{"type":"object","object":{"properties":{"transformation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Transformation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to transform a media item.","plainTextDescription":"Request to transform a media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"specification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioSpecification"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for audio media items.","plainTextDescription":"Metadata for audio media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LlmSpec"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"chat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ChatLlmSpecWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specification for language model requests.","plainTextDescription":"Specification for language model requests.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImagePixelCoordinate"},"type":{"type":"object","object":{"properties":{"x":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Coordinate on the x-axis (width).","plainTextDescription":"Coordinate on the x-axis (width).","example":[]}},"y":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Coordinate on the y-axis (height).","plainTextDescription":"Coordinate on the y-axis (height).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Coordinate of a pixel in an image (x, y). Top left corner of the image is (0, 0).\n","plainTextDescription":"Coordinate of a pixel in an image (x, y). Top left corner of the image is (0, 0).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RotationAngle"},"type":{"type":"enum","enum":{"values":["DEGREE_90","DEGREE_180","DEGREE_270","UNKNOWN"]}},"safety":"SAFE","documentation":{"description":"The rotation angle from EXIF orientation.","plainTextDescription":"The rotation angle from EXIF orientation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Model3dMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Model3dDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"modelType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Model3dType"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for 3D model media items.","plainTextDescription":"Metadata for 3D model media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TiffFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"TIFF image format.","plainTextDescription":"TIFF image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractFormFieldsOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts form field data from a PDF document.","plainTextDescription":"Extracts form field data from a PDF document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscribeOperation"},"type":{"type":"object","object":{"properties":{"language":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscriptionLanguage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"diarize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to perform speaker diarization. Defaults to false.\nNot supported in economical performance mode.\n","plainTextDescription":"Whether to perform speaker diarization. Defaults to false.\nNot supported in economical performance mode.","example":[]}},"outputFormat":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscribeTextEncodeFormat"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"performanceMode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PerformanceMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transcribes speech in audio to text.","plainTextDescription":"Transcribes speech in audio to text.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguage"},"type":{"type":"enum","enum":{"values":["AFR","AMH","ARA","ASM","AZE","AZE_CYRL","BEL","BEN","BOD","BOS","BRE","BUL","CAT","CEB","CES","CHI_SIM","CHI_SIM_VERT","CHI_TRA","CHI_TRA_VERT","CHR","COS","CYM","DAN","DEU","DIV","DZO","ELL","ENG","ENM","EPO","EST","EUS","FAO","FAS","FIL","FIN","FRA","FRM","FRY","GLA","GLE","GLG","GRC","GUJ","HAT","HEB","HIN","HRV","HUN","HYE","IKU","IND","ISL","ITA","ITA_OLD","JAV","JPN","JPN_VERT","KAN","KAT","KAT_OLD","KAZ","KHM","KIR","KMR","KOR","KOR_VERT","LAO","LAT","LAV","LIT","LTZ","MAL","MAR","MKD","MLT","MON","MRI","MSA","MYA","NEP","NLD","NOR","OCI","ORI","OSD","PAN","POL","POR","PUS","QUE","RON","RUS","SAN","SIN","SLK","SLV","SND","SPA","SPA_OLD","SQI","SRP","SRP_LATN","SUN","SWA","SWE","SYR","TAM","TAT","TEL","TGK","THA","TIR","TON","TUR","UIG","UKR","URD","UZB","UZB_CYRL","VIE","YID","YOR"]}},"safety":"SAFE","documentation":{"description":"Language codes for OCR.","plainTextDescription":"Language codes for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastBinarize"},"type":{"type":"object","object":{"properties":{"threshold":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The threshold value (0-255). Pixels with intensity below this value become black,\nothers become white. If not specified, the threshold is computed automatically.\n","plainTextDescription":"The threshold value (0-255). Pixels with intensity below this value become black,\nothers become white. If not specified, the threshold is computed automatically.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Binarize contrast operation.","plainTextDescription":"Binarize contrast operation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPageOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The page number to perform OCR on.","plainTextDescription":"The page number to perform OCR on.","example":[]}},"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Performs OCR (Optical Character Recognition) on a specific page of a document.","plainTextDescription":"Performs OCR (Optical Character Recognition) on a specific page of a document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AvailableEmbeddingModelIds"},"type":{"type":"enum","enum":{"values":["GOOGLE_SIGLIP_2"]}},"safety":"SAFE","documentation":{"description":"Available embedding models that can be used with the service.","plainTextDescription":"Available embedding models that can be used with the service.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"v1":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformationV1"}}}}}}},"safety":"UNSAFE","documentation":{"description":"DICOM meta information.","plainTextDescription":"DICOM meta information.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageryDecodeFormat"},"type":{"type":"enum","enum":{"values":["BMP","TIFF","NITF","JP2K","JPG","PNG","WEBP"]}},"safety":"SAFE","documentation":{"description":"The format of an imagery media item.","plainTextDescription":"The format of an imagery media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformationV1"},"type":{"type":"object","object":{"properties":{"mediaStorageSop":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The Media Storage SOP (Service-Object Pair) Class UID, which identifies \nthe type of DICOM object stored (e.g., CT Image, MR Image).\n","plainTextDescription":"The Media Storage SOP (Service-Object Pair) Class UID, which identifies\nthe type of DICOM object stored (e.g., CT Image, MR Image).","example":[]}},"mediaStorageSopInstance":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The Media Storage SOP Instance UID.","plainTextDescription":"The Media Storage SOP Instance UID.","example":[]}},"transferSyntax":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The Transfer Syntax UID, which specifies how the DICOM data is encoded \n(e.g., compression method, byte ordering).\n","plainTextDescription":"The Transfer Syntax UID, which specifies how the DICOM data is encoded\n(e.g., compression method, byte ordering).","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"DICOM meta information version 1.","plainTextDescription":"DICOM meta information version 1.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoSpecification"},"type":{"type":"object","object":{"properties":{"bitRate":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Approximate (average) bits per second of the video, rounded up in case of a fractional average bits per second.\n","plainTextDescription":"Approximate (average) bits per second of the video, rounded up in case of a fractional average bits per second.","example":[]}},"durationSeconds":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"Approximate duration of the video, in seconds with up to two decimal digits (rounded up).\n","plainTextDescription":"Approximate duration of the video, in seconds with up to two decimal digits (rounded up).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Technical specifications for video media items.","plainTextDescription":"Technical specifications for video media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"convertSheetToJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ConvertSheetToJsonOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for spreadsheet to text conversion.","plainTextDescription":"The operation to perform for spreadsheet to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mp3":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mp3Format"}}}},"wav":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"WavEncodeFormat"}}}},"ts":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TsAudioContainerFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding audio.","plainTextDescription":"The output format for encoding audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageWrapper"},"type":{"type":"object","object":{"properties":{"language":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguage"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Wrapper for an OCR language.","plainTextDescription":"Wrapper for an OCR language.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SceneScore"},"type":{"type":"enum","enum":{"values":["MORE_SENSITIVE","STANDARD","LESS_SENSITIVE"]}},"safety":"SAFE","documentation":{"description":"The sensitivity threshold for scene detection.","plainTextDescription":"The sensitivity threshold for scene detection.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Generates embeddings from images.","plainTextDescription":"Generates embeddings from images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSet"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaSetName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parentFolderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FolderRid"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TsVideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MPEG Transport Stream video container format.","plainTextDescription":"MPEG Transport Stream video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"FlipAxis"},"type":{"type":"enum","enum":{"values":["HORIZONTAL","VERTICAL","UNKNOWN"]}},"safety":"SAFE","documentation":{"description":"The flip axis from EXIF orientation.","plainTextDescription":"The flip axis from EXIF orientation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"specification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoSpecification"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for video media items.","plainTextDescription":"Metadata for video media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BandInfo"},"type":{"type":"object","object":{"properties":{"dataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DataType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"colorInterpretation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ColorInterpretation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"paletteInterpretation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PaletteInterpretation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"unitInterpretation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"UnitInterpretation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Information about a band in an image.","plainTextDescription":"Information about a band in an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MailboxWrapper"},"type":{"type":"object","object":{"properties":{"mailbox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A wrapper for a mailbox in the MailboxOrGroup union.","plainTextDescription":"A wrapper for a mailbox in the MailboxOrGroup union.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaSetResponse"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSchema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaSchema"}}},"safety":"SAFE","documentation":{"example":[]}},"defaultBranchName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BranchName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"transactionPolicy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransactionPolicy"}}},"safety":"UNSAFE","documentation":{"example":[]}},"pathsRequired":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether media items in this media set require paths.","plainTextDescription":"Whether media items in this media set require paths.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Information about a media set.","plainTextDescription":"Information about a media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TextOutputFormat"},"type":{"type":"enum","enum":{"values":["TEXT","MARKDOWN","HTML"]}},"safety":"SAFE","documentation":{"description":"Format in which to return extracted text.","plainTextDescription":"Format in which to return extracted text.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetEmailBodyOperation"},"type":{"type":"object","object":{"properties":{"outputFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextEncodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Gets the email body in the specified format.","plainTextDescription":"Gets the email body in the specified format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaType"},"type":{"type":"enum","enum":{"values":["IMAGE","MULTI_FRAME_IMAGE","VIDEO","STRUCTURED_REPORT"]}},"safety":"SAFE","documentation":{"description":"The type of DICOM media.","plainTextDescription":"The type of DICOM media.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The key of an image attribute within a domain.","plainTextDescription":"The key of an image attribute within a domain.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"renderPageToFitBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RenderPageToFitBoundingBoxOperation"}}}},"renderPage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RenderPageOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for document to image conversion.","plainTextDescription":"The operation to perform for document to image conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractFirstFrame":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractFirstFrameOperation"}}}},"extractFramesAtTimestamps":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractFramesAtTimestampsOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to image conversion.","plainTextDescription":"The operation to perform for video to image conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BoundingBoxGeometry"},"type":{"type":"object","object":{"properties":{"boundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BoundingBox"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A rectangular bounding box geometry for annotations.","plainTextDescription":"A rectangular bounding box geometry for annotations.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LogicalTimestamp"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"A number representing a logical ordering to be used for transactions, etc.\nThis can be interpreted as a timestamp in microseconds, but may differ slightly from system clock time due \nto clock drift and slight adjustments for the sake of ordering.\n\nOnly positive timestamps (representing times after epoch) are supported.\n","plainTextDescription":"A number representing a logical ordering to be used for transactions, etc.\nThis can be interpreted as a timestamp in microseconds, but may differ slightly from system clock time due\nto clock drift and slight adjustments for the sake of ordering.\nOnly positive timestamps (representing times after epoch) are supported.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The display name of the mailbox.","plainTextDescription":"The display name of the mailbox.","example":[]}},"emailAddress":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The email address of the mailbox.","plainTextDescription":"The email address of the mailbox.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An email mailbox with an optional display name and email address.","plainTextDescription":"An email mailbox with an optional display name and email address.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TranscribeJson"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"JSON transcription output format.","plainTextDescription":"JSON transcription output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DataType"},"type":{"type":"enum","enum":{"values":["UNDEFINED","BYTE","UINT16","INT16","UINT32","INT32","FLOAT32","FLOAT64","COMPLEX_INT16","COMPLEX_INT32","COMPLEX_FLOAT32","COMPLEX_FLOAT64","UINT64","INT64","INT8"]}},"safety":"SAFE","documentation":{"description":"The data type of a band.","plainTextDescription":"The data type of a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ArchiveEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts video frames to an archive format.","plainTextDescription":"Extracts video frames to an archive format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Mp3Format"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MP3 audio format.","plainTextDescription":"MP3 audio format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Dimensions"},"type":{"type":"object","object":{"properties":{"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The width of the image in pixels.","plainTextDescription":"The width of the image in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The height of the image in pixels.","plainTextDescription":"The height of the image in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"The dimensions of an image.","plainTextDescription":"The dimensions of an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrScript"},"type":{"type":"enum","enum":{"values":["ARABIC","ARMENIAN","BENGALI","CANADIAN_ABORIGINAL","CHEROKEE","CYRILLIC","DEVANAGARI","ETHIOPIC","FRAKTUR","GEORGIAN","GREEK","GUJARATI","GURMUKHI","HAN_SIMPLIFIED","HAN_SIMPLIFIED_VERT","HAN_TRADITIONAL","HAN_TRADITIONAL_VERT","HANGUL","HANGUL_VERT","HEBREW","JAPANESE","JAPANESE_VERT","KANNADA","KHMER","LAO","LATIN","MALAYALAM","MYANMAR","ORIYA","SINHALA","SYRIAC","TAMIL","TELUGU","THAANA","THAI","TIBETAN","VIETNAMESE"]}},"safety":"SAFE","documentation":{"description":"Script codes for OCR.","plainTextDescription":"Script codes for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts text from documents.","plainTextDescription":"Extracts text from documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetDecodeFormat"},"type":{"type":"enum","enum":{"values":["CSV","XLSX"]}},"safety":"SAFE","documentation":{"description":"The format of a spreadsheet media item.","plainTextDescription":"The format of a spreadsheet media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractVlmTextOperation"},"type":{"type":"object","object":{"properties":{"llmSpec":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LlmSpec"}}},"safety":"UNSAFE","documentation":{"example":[]}},"preprocessingConfiguration":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VlmPreprocessingConfig"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"imageSpec":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageSpec"}}}}},"safety":"SAFE","documentation":{"example":[]}},"outputFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VlmOutputFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"pageRange":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PageRange"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extract text from a document using vision language models (VLMs).\nVLMs can understand document layout and structure more intelligently than traditional OCR.\n","plainTextDescription":"Extract text from a document using vision language models (VLMs).\nVLMs can understand document layout and structure more intelligently than traditional OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ResizeImageOperation"},"type":{"type":"object","object":{"properties":{"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}},"autoOrient":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to automatically orient the image based on EXIF metadata.\n","plainTextDescription":"Whether to automatically orient the image based on EXIF metadata.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Resizes an image to the specified dimensions.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Resizes an image to the specified dimensions.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConvertDocumentOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Converts a document to PDF format.","plainTextDescription":"Converts a document to PDF format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageSpec"},"type":{"type":"object","object":{"properties":{"resizingMode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ResizingMode"}}},"safety":"SAFE","documentation":{"example":[]}},"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Target height in pixels.","plainTextDescription":"Target height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Target width in pixels.","plainTextDescription":"Target width in pixels.","example":[]}},"mimeType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specification for image processing parameters used in vision-based extraction.\nControls how document pages are converted to images before being sent to vision models.\n","plainTextDescription":"Specification for image processing parameters used in vision-based extraction.\nControls how document pages are converted to images before being sent to vision models.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts audio to text.","plainTextDescription":"Converts audio to text.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Model3dDecodeFormat"},"type":{"type":"enum","enum":{"values":["LAS","PLY","OBJ"]}},"safety":"SAFE","documentation":{"description":"The format of a 3D model media item.","plainTextDescription":"The format of a 3D model media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastEqualize"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Equalizes the histogram of an image to improve contrast.","plainTextDescription":"Equalizes the histogram of an image to improve contrast.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Color"},"type":{"type":"object","object":{"properties":{"r":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Red component (0-255).","plainTextDescription":"Red component (0-255).","example":[]}},"g":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Green component (0-255).","plainTextDescription":"Green component (0-255).","example":[]}},"b":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Blue component (0-255).","plainTextDescription":"Blue component (0-255).","example":[]}},"a":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"Alpha component (0-1, where 0 is transparent and 1 is opaque).","plainTextDescription":"Alpha component (0-1, where 0 is transparent and 1 is opaque).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"An RGBA color value.","plainTextDescription":"An RGBA color value.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConvertSheetToJsonOperation"},"type":{"type":"object","object":{"properties":{"sheetName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The sheet name.","plainTextDescription":"The sheet name.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts a specified sheet to JSON format.","plainTextDescription":"Converts a specified sheet to JSON format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PageRange"},"type":{"type":"object","object":{"properties":{"startPageInclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Start page index (0-based, inclusive). If not provided, defaults to start of document.","plainTextDescription":"Start page index (0-based, inclusive). If not provided, defaults to start of document.","example":[]}},"endPageExclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"End page index (0-based, exclusive). If not provided, defaults to end of document.","plainTextDescription":"End page index (0-based, exclusive). If not provided, defaults to end of document.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Page range for document extraction.","plainTextDescription":"Page range for document extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Renders document pages as images.","plainTextDescription":"Renders document pages as images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemInfoResponse"},"type":{"type":"object","object":{"properties":{"viewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"logicalTimestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LogicalTimestamp"}}},"safety":"SAFE","documentation":{"example":[]}},"attribution":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaAttribution"}}}}},"safety":"SAFE","documentation":{"example":[]}},"originallyUploadedFileMimeType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"mimeType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GrayscaleImageOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Converts an image to grayscale.","plainTextDescription":"Converts an image to grayscale.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TarFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"TAR archive format.","plainTextDescription":"TAR archive format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"renderImageLayer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RenderImageLayerOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for DICOM to image conversion.","plainTextDescription":"The operation to perform for DICOM to image conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RegisterMediaItemRequest"},"type":{"type":"object","object":{"properties":{"physicalItemName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The relative path within the federated media store where the media item exists.","plainTextDescription":"The relative path within the federated media store where the media item exists.","example":[]}},"mediaItemPath":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to register a media item from a federated store.","plainTextDescription":"Request to register a media item from a federated store.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSetName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioChunkOperation"},"type":{"type":"object","object":{"properties":{"chunkDurationMilliseconds":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Duration of each chunk in milliseconds.","plainTextDescription":"Duration of each chunk in milliseconds.","example":[]}},"encodeFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"chunkIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The chunk index to retain.","plainTextDescription":"The chunk index to retain.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Chunks audio into smaller segments of the specified duration.","plainTextDescription":"Chunks audio into smaller segments of the specified duration.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentExtractLayoutAwareContentOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionParameters"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Extracts content from a document with layout information preserved.","plainTextDescription":"Extracts content from a document with layout information preserved.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractFramesAtTimestampsOperation"},"type":{"type":"object","object":{"properties":{"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"description":"The timestamp in seconds.","plainTextDescription":"The timestamp in seconds.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts frames from the video at specified timestamps.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Extracts frames from the video at specified timestamps.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemRidByPathResponse"},"type":{"type":"object","object":{"properties":{"mediaItemRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Mp4VideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MP4 video container format.","plainTextDescription":"MP4 video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"WaveformOperation"},"type":{"type":"object","object":{"properties":{"peaksPerSecond":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The number of peaks per second (1-1000).","plainTextDescription":"The number of peaks per second (1-1000).","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Generates waveform visualization data from audio.\nReturns JSON with normalized doubles (0-1) representing amplitude.\n","plainTextDescription":"Generates waveform visualization data from audio.\nReturns JSON with normalized doubles (0-1) representing amplitude.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioDecodeFormat"},"type":{"type":"enum","enum":{"values":["FLAC","MP2","MP3","MP4","NIST_SPHERE","OGG","WAV","WEBM"]}},"safety":"SAFE","documentation":{"description":"The format of an audio media item.","plainTextDescription":"The format of an audio media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"transcode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscodeOperation"}}}},"chunk":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoChunkOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform on the video.","plainTextDescription":"The operation to perform on the video.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SlicePdfRangeOperation"},"type":{"type":"object","object":{"properties":{"startPageInclusive":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The zero-indexed start page (inclusive).","plainTextDescription":"The zero-indexed start page (inclusive).","example":[]}},"endPageExclusive":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The zero-indexed end page (exclusive).","plainTextDescription":"The zero-indexed end page (exclusive).","example":[]}},"strictlyEnforceEndPage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true (default), the operation fails if endPage exceeds the document's page count.\nIf false, ends at min(endPage, lastPage).\n","plainTextDescription":"If true (default), the operation fails if endPage exceeds the document's page count.\nIf false, ends at min(endPage, lastPage).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Slices a PDF to a specified page range.","plainTextDescription":"Slices a PDF to a specified page range.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentDecodeFormat"},"type":{"type":"enum","enum":{"values":["PDF","DOC","DOCX","TXT","PPTX","RTF"]}},"safety":"SAFE","documentation":{"description":"The format of a document media item.","plainTextDescription":"The format of a document media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeDomain"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The domain of an image attribute.","plainTextDescription":"The domain of an image attribute.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrHocrOutputFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"hOCR (HTML-based OCR) output format.","plainTextDescription":"hOCR (HTML-based OCR) output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemXmlFormat"},"type":{"type":"enum","enum":{"values":["DOCX","XLSX","PPTX"]}},"safety":"SAFE","documentation":{"description":"Format of the media item attempted to be decoded based on the XML structure.","plainTextDescription":"Format of the media item attempted to be decoded based on the XML structure.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TsAudioContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MPEG Transport Stream audio container format.","plainTextDescription":"MPEG Transport Stream audio container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractAudio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractAudioOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to audio conversion.","plainTextDescription":"The operation to perform for video to audio conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BoundingBox"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The left coordinate of the bounding box.","plainTextDescription":"The left coordinate of the bounding box.","example":[]}},"top":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The top coordinate of the bounding box.","plainTextDescription":"The top coordinate of the bounding box.","example":[]}},"width":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The width of the bounding box.","plainTextDescription":"The width of the bounding box.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The height of the bounding box.","plainTextDescription":"The height of the bounding box.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A rectangular bounding box for annotations.","plainTextDescription":"A rectangular bounding box for annotations.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MovVideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MOV (QuickTime) video container format.","plainTextDescription":"MOV (QuickTime) video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Annotation"},"type":{"type":"object","object":{"properties":{"geometry":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AnnotateGeometry"}}},"safety":"UNSAFE","documentation":{"example":[]}},"label":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"An optional text label to display with the annotation.","plainTextDescription":"An optional text label to display with the annotation.","example":[]}},"color":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Color"}}}}},"safety":"SAFE","documentation":{"example":[]}},"thickness":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"The thickness of the annotation lines.","plainTextDescription":"The thickness of the annotation lines.","example":[]}},"fontSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The font size for the label text.","plainTextDescription":"The font size for the label text.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An annotation to draw on an image.","plainTextDescription":"An annotation to draw on an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailDecodeFormat"},"type":{"type":"enum","enum":{"values":["EML"]}},"safety":"SAFE","documentation":{"description":"The format of an email media item.","plainTextDescription":"The format of an email media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Operation"},"type":{"type":"object","object":{"properties":{"pageRange":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PageRange"}}}}},"safety":"SAFE","documentation":{"example":[]}},"config":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extract text across all pages using the v2 text extraction endpoint with per page text.\nThis only supports PDFs.\n","plainTextDescription":"Extract text across all pages using the v2 text extraction endpoint with per page text.\nThis only supports PDFs.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts images to documents.","plainTextDescription":"Converts images to documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"rotate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"RotateImageOperation"}}}},"resizeToFitBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ResizeToFitBoundingBoxOperation"}}}},"encrypt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EncryptImageOperation"}}}},"contrast":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastImageOperation"}}}},"tile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TileImageOperation"}}}},"resize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ResizeImageOperation"}}}},"annotate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AnnotateImageOperation"}}}},"decrypt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DecryptImageOperation"}}}},"crop":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CropImageOperation"}}}},"grayscale":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GrayscaleImageOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An operation to perform on an image.","plainTextDescription":"An operation to perform on an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ArchiveEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"tar":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TarFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding archives.","plainTextDescription":"The output format for encoding archives.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"getEmailAttachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetEmailAttachmentOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for email to attachment extraction.","plainTextDescription":"The operation to perform for email to attachment extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DecryptImageOperation"},"type":{"type":"object","object":{"properties":{"polygons":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageRegionPolygon"}}}}},"safety":"SAFE","documentation":{"description":"The polygons defining the regions to decrypt.","plainTextDescription":"The polygons defining the regions to decrypt.","example":[]}},"cipherLicenseRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The resource identifier for the cipher license.","plainTextDescription":"The resource identifier for the cipher license.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Decrypts bounding boxes in an image using a commutative encryption algorithm.","plainTextDescription":"Decrypts bounding boxes in an image using a commutative encryption algorithm.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PdfFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"PDF document format.","plainTextDescription":"PDF document format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrOnPagesOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageNumber":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The page number.","plainTextDescription":"The page number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Creates access patterns for OCR across pages of a document.","plainTextDescription":"Creates access patterns for OCR across pages of a document.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Converts spreadsheet data to text/JSON.","plainTextDescription":"Converts spreadsheet data to text/JSON.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CadUnits"},"type":{"type":"object","object":{"properties":{"lengthUnit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Raw declared length unit name, for example MILLIMETRE, METRE, INCH, or FOOT. Consumers should match\ncase-insensitively and tolerate unknown values.\n","plainTextDescription":"Raw declared length unit name, for example MILLIMETRE, METRE, INCH, or FOOT. Consumers should match\ncase-insensitively and tolerate unknown values.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Units declared in a CAD file.","plainTextDescription":"Units declared in a CAD file.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VlmPreprocessingConfig"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"layoutAware":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwarePreprocessingWrapper"}}}},"extractText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractTextPreprocessingWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Preprocessing configuration for VLM extraction.","plainTextDescription":"Preprocessing configuration for VLM extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"getTimestampsForSceneFrames":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GetTimestampsForSceneFramesOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for video to text conversion.","plainTextDescription":"The operation to perform for video to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PngFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"PNG image format.","plainTextDescription":"PNG image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MkvVideoContainerFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"MKV (Matroska) video container format.","plainTextDescription":"MKV (Matroska) video container format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"generateEmbedding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GenerateEmbeddingOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for image to embedding conversion.","plainTextDescription":"The operation to perform for image to embedding conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts text from images.","plainTextDescription":"Extracts text from images.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetTransformationJobStatusResponse"},"type":{"type":"object","object":{"properties":{"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"jobId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response containing the status of a transformation job.","plainTextDescription":"Response containing the status of a transformation job.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"NoTransactionsTransactionPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Writes are not part of a transaction and are immediately visible.\nCalls to create transaction or commit transaction will error.\n","plainTextDescription":"Writes are not part of a transaction and are immediately visible.\nCalls to create transaction or commit transaction will error.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"sender":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mailbox"}}}}},"safety":"UNSAFE","documentation":{"description":"The sender(s) of the email.","plainTextDescription":"The sender(s) of the email.","example":[]}},"date":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"The date the email was sent.","plainTextDescription":"The date the email was sent.","example":[]}},"attachmentCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The number of attachments in the email.","plainTextDescription":"The number of attachments in the email.","example":[]}},"to":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MailboxOrGroup"}}}}},"safety":"UNSAFE","documentation":{"description":"The recipient(s) of the email.","plainTextDescription":"The recipient(s) of the email.","example":[]}},"cc":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MailboxOrGroup"}}}}},"safety":"UNSAFE","documentation":{"description":"The CC recipient(s) of the email.","plainTextDescription":"The CC recipient(s) of the email.","example":[]}},"subject":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The subject of the email.","plainTextDescription":"The subject of the email.","example":[]}},"attachments":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailAttachment"}}}}},"safety":"UNSAFE","documentation":{"description":"The attachments of the email.","plainTextDescription":"The attachments of the email.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for email media items.","plainTextDescription":"Metadata for email media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageryMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"dimensions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Dimensions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"bands":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BandInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"Information about the bands of the image, if available.","plainTextDescription":"Information about the bands of the image, if available.","example":[]}},"attributes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeDomain"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageAttributeKey"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}}}},"safety":"UNSAFE","documentation":{"description":"The metadata attributes described in the image header in the form of a map >.\nFor the default domain, or when the domain is not specified, the domain key will be the empty string (\"\").\n","plainTextDescription":"The metadata attributes described in the image header in the form of a map >.\nFor the default domain, or when the domain is not specified, the domain key will be the empty string (\"\").","example":[]}},"iccProfile":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The base64-encoded ICC profile for the image, if available.","plainTextDescription":"The base64-encoded ICC profile for the image, if available.","example":[]}},"geo":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GeoMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pages":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The number of pages associated with this image. Usually 1, but may be more for some formats\n(multi-page TIFFs, for example).\n","plainTextDescription":"The number of pages associated with this image. Usually 1, but may be more for some formats\n(multi-page TIFFs, for example).","example":[]}},"orientation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Orientation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for imagery (image) media items.","plainTextDescription":"Metadata for imagery (image) media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemMetadata"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"cad":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CadMediaItemMetadata"}}}},"document":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentMediaItemMetadata"}}}},"imagery":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryMediaItemMetadata"}}}},"spreadsheet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetMediaItemMetadata"}}}},"untyped":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"UntypedMediaItemMetadata"}}}},"audio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioMediaItemMetadata"}}}},"model3d":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Model3dMediaItemMetadata"}}}},"video":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoMediaItemMetadata"}}}},"dicom":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaItemMetadata"}}}},"email":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailMediaItemMetadata"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Detailed metadata about a media item, including type-specific information such as dimensions for images,\nduration for audio/video, page count for documents, etc.\n","plainTextDescription":"Detailed metadata about a media item, including type-specific information such as dimensions for images,\nduration for audio/video, page count for documents, etc.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PlainTextNoSegmentData"},"type":{"type":"object","object":{"properties":{"addTimestamps":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether to include timestamps in the output.","plainTextDescription":"Whether to include timestamps in the output.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Plain text transcription output format.","plainTextDescription":"Plain text transcription output format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransactionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"An identifier which represents a transaction on a media set.\n","plainTextDescription":"An identifier which represents a transaction on a media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"metaInformation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMetaInformation"}}},"safety":"UNSAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomMediaType"}}},"safety":"SAFE","documentation":{"example":[]}},"commonDataElements":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CommonDicomDataElements"}}},"safety":"UNSAFE","documentation":{"example":[]}},"otherDataElements":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomDataElementKey"}}},"valueType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"The data elements for a particular DICOM file outside of the media contained within it and the\ndata elements within the commonDataElements field.\n","plainTextDescription":"The data elements for a particular DICOM file outside of the media contained within it and the\ndata elements within the commonDataElements field.","example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.","plainTextDescription":"Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UntypedMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Metadata for untyped media items (media items without a recognized type).","plainTextDescription":"Metadata for untyped media items (media items without a recognized type).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AffineTransform"},"type":{"type":"object","object":{"properties":{"xTranslate":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"xScale":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"xShear":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"yTranslate":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"yShear":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"yScale":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An affine transformation for geo-referencing.","plainTextDescription":"An affine transformation for geo-referencing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TrackedTransformationPendingResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AnnotateGeometry"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"boundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"BoundingBoxGeometry"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The geometry for an annotation.","plainTextDescription":"The geometry for an annotation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CommonDicomDataElements"},"type":{"type":"object","object":{"properties":{"numberFrames":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"description":"The number of frames in the DICOM file.","plainTextDescription":"The number of frames in the DICOM file.","example":[]}},"modality":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Modality"}}}}},"safety":"SAFE","documentation":{"example":[]}},"patientId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The patient ID.","plainTextDescription":"The patient ID.","example":[]}},"studyId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The study ID.","plainTextDescription":"The study ID.","example":[]}},"studyUid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The study UID.","plainTextDescription":"The study UID.","example":[]}},"seriesUid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The series UID.","plainTextDescription":"The series UID.","example":[]}},"studyTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"description":"The study time.","plainTextDescription":"The study time.","example":[]}},"seriesTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"description":"The series time.","plainTextDescription":"The series time.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Common DICOM data elements.","plainTextDescription":"Common DICOM data elements.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractSceneFramesOperation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageryEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sceneScore":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SceneScore"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts all scene frames from a video as images in an archive.","plainTextDescription":"Extracts all scene frames from a video as images in an archive.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformMediaItemResponse"},"type":{"type":"object","object":{"properties":{"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"jobId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response from initiating a media item transformation.","plainTextDescription":"Response from initiating a media item transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"extractLayoutAwareContent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageExtractLayoutAwareContentOperation"}}}},"ocr":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageOcrOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for image to text conversion.","plainTextDescription":"The operation to perform for image to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BatchTransactionsTransactionPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"All writes must be part of a transaction. Transactions are branch-scoped and created by calling\ncreate transaction. Writes are not visible until commit transaction is called.\n","plainTextDescription":"All writes must be part of a transaction. Transactions are branch-scoped and created by calling\ncreate transaction. Writes are not visible until commit transaction is called.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Transforms video media items.","plainTextDescription":"Transforms video media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts attachments from email.","plainTextDescription":"Extracts attachments from email.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoChunkOperation"},"type":{"type":"object","object":{"properties":{"chunkDurationMilliseconds":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Duration of each chunk in milliseconds.","plainTextDescription":"Duration of each chunk in milliseconds.","example":[]}},"chunkIndex":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The chunk index to retain.","plainTextDescription":"The chunk index to retain.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Chunks video into smaller segments of the specified duration.\nThe final chunk may be smaller than the specified duration.\n","plainTextDescription":"Chunks video into smaller segments of the specified duration.\nThe final chunk may be smaller than the specified duration.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractAllTextOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts text across all pages of the document.\nFor PDF documents, includes all text. For DocX documents, includes only regular paragraphs.\n","plainTextDescription":"Extracts text across all pages of the document.\nFor PDF documents, includes all text. For DocX documents, includes only regular paragraphs.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrTextOutputFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Plain text output format for OCR.","plainTextDescription":"Plain text output format for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"RenderPageOperation"},"type":{"type":"object","object":{"properties":{"pageNumber":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The zero-indexed page number to render. Defaults to the first page if not specified.","plainTextDescription":"The zero-indexed page number to render. Defaults to the first page if not specified.","example":[]}},"height":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired height in pixels.","plainTextDescription":"The desired height in pixels.","example":[]}},"width":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The desired width in pixels.","plainTextDescription":"The desired width in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Renders a PDF page as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.\n","plainTextDescription":"Renders a PDF page as an image.\nIf only one dimension is specified, the other is calculated to preserve aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextTransformation"},"type":{"type":"object","object":{"properties":{"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts metadata from video as text/JSON.","plainTextDescription":"Extracts metadata from video as text/JSON.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"sheetNames":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The names of the sheets in the spreadsheet.","plainTextDescription":"The names of the sheets in the spreadsheet.","example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"title":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The title of the spreadsheet, if available.","plainTextDescription":"The title of the spreadsheet, if available.","example":[]}},"author":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The author of the spreadsheet, if available.","plainTextDescription":"The author of the spreadsheet, if available.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for spreadsheet media items.","plainTextDescription":"Metadata for spreadsheet media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ColorInterpretation"},"type":{"type":"enum","enum":{"values":["UNDEFINED","GRAY","PALETTE_INDEX","RED","GREEN","BLUE","ALPHA","HUE","SATURATION","LIGHTNESS","CYAN","MAGENTA","YELLOW","BLACK","Y_CB_CR_SPACE_Y","Y_CB_CR_SPACE_CB","Y_CB_CR_SPACE_CR"]}},"safety":"SAFE","documentation":{"description":"The color interpretation of a band.","plainTextDescription":"The color interpretation of a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelOperation"},"type":{"type":"object","object":{"properties":{"encodeFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"channel":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The channel number to select.","plainTextDescription":"The channel number to select.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Selects a specific channel from multi-channel audio.","plainTextDescription":"Selects a specific channel from multi-channel audio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CropImageOperation"},"type":{"type":"object","object":{"properties":{"xOffset":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The x offset in pixels from the left hand side of the image.","plainTextDescription":"The x offset in pixels from the left hand side of the image.","example":[]}},"yOffset":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The y offset in pixels from the top of the image.","plainTextDescription":"The y offset in pixels from the top of the image.","example":[]}},"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The width of the cropping box in pixels.","plainTextDescription":"The width of the cropping box in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The height of the cropping box in pixels.","plainTextDescription":"The height of the cropping box in pixels.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Crops an image to a rectangular sub-window.","plainTextDescription":"Crops an image to a rectangular sub-window.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CadDecodeFormat"},"type":{"type":"enum","enum":{"values":["STEP"]}},"safety":"SAFE","documentation":{"description":"The format of a CAD media item.","plainTextDescription":"The format of a CAD media item.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ResizeToFitBoundingBoxOperation"},"type":{"type":"object","object":{"properties":{"width":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The width of the bounding box in pixels.","plainTextDescription":"The width of the bounding box in pixels.","example":[]}},"height":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The height of the bounding box in pixels.","plainTextDescription":"The height of the bounding box in pixels.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Resizes an image to maximally fit within a bounding box while preserving aspect ratio.\n","plainTextDescription":"Resizes an image to maximally fit within a bounding box while preserving aspect ratio.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GenerateEmbeddingOperation"},"type":{"type":"object","object":{"properties":{"modelId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AvailableEmbeddingModelIds"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Generates a vector embedding for an image using the specified model.","plainTextDescription":"Generates a vector embedding for an image using the specified model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Operation"},"type":{"type":"object","object":{"properties":{"pageRange":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PageRange"}}}}},"safety":"SAFE","documentation":{"example":[]}},"config":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint.\nThis only supports PDFs.\n","plainTextDescription":"Extract layout aware text with bounding boxes across all pages using the v2 text extraction endpoint.\nThis only supports PDFs.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"pages":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The number of pages in the document.","plainTextDescription":"The number of pages in the document.","example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"title":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The title of the document, if available.","plainTextDescription":"The title of the document, if available.","example":[]}},"author":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The author of the document, if available.","plainTextDescription":"The author of the document, if available.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for document media items.","plainTextDescription":"Metadata for document media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mp4":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"Mp4VideoContainerFormat"}}}},"mov":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MovVideoContainerFormat"}}}},"mkv":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MkvVideoContainerFormat"}}}},"ts":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TsVideoContainerFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding video.","plainTextDescription":"The output format for encoding video.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationJobStatus"},"type":{"type":"enum","enum":{"values":["PENDING","FAILED","SUCCESSFUL"]}},"safety":"SAFE","documentation":{"description":"The status of a transformation job.","plainTextDescription":"The status of a transformation job.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CadMediaItemMetadata"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CadDecodeFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The size of the media item in bytes.","plainTextDescription":"The size of the media item in bytes.","example":[]}},"units":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CadUnits"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata for CAD media items.","plainTextDescription":"Metadata for CAD media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioTransformation"},"type":{"type":"object","object":{"properties":{"encoding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioEncodeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts audio from video.","plainTextDescription":"Extracts audio from video.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastImageOperation"},"type":{"type":"object","object":{"properties":{"contrastType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ContrastType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Applies contrast adjustments to an image.","plainTextDescription":"Applies contrast adjustments to an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"transcribe":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TranscribeOperation"}}}},"waveform":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"WaveformOperation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The operation to perform for audio to text conversion.","plainTextDescription":"The operation to perform for audio to text conversion.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"Transformation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"emailToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToTextTransformation"}}}},"image":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageTransformation"}}}},"spreadsheetToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"SpreadsheetToTextTransformation"}}}},"videoToAudio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToAudioTransformation"}}}},"audioToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioToTextTransformation"}}}},"emailToAttachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"EmailToAttachmentTransformation"}}}},"videoToArchive":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToArchiveTransformation"}}}},"videoToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToTextTransformation"}}}},"imageToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToTextTransformation"}}}},"videoToImage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoToImageTransformation"}}}},"video":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"VideoTransformation"}}}},"imageToDocument":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToDocumentTransformation"}}}},"dicomToImage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DicomToImageTransformation"}}}},"documentToDocument":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToDocumentTransformation"}}}},"documentToImage":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToImageTransformation"}}}},"imageToEmbedding":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ImageToEmbeddingTransformation"}}}},"audio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"AudioTransformation"}}}},"documentToText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"DocumentToTextTransformation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A transformation to apply to a media item. Each variant specifies the type of transformation\nand any parameters required for the operation.\n","plainTextDescription":"A transformation to apply to a media item. Each variant specifies the type of transformation\nand any parameters required for the operation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"DocumentEncodeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"pdf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"PdfFormat"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The output format for encoding documents.","plainTextDescription":"The output format for encoding documents.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"BranchRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"A resource identifier that identifies a branch of a media set.\n","plainTextDescription":"A resource identifier that identifies a branch of a media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MailboxOrGroup"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mailbox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MailboxWrapper"}}}},"group":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"GroupWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Either a mailbox or a group of mailboxes.","plainTextDescription":"Either a mailbox or a group of mailboxes.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"CropConfig"},"type":{"type":"object","object":{"properties":{"tablePrompt":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Prompt for table extraction.","plainTextDescription":"Prompt for table extraction.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for table cropping.","plainTextDescription":"Configuration for table cropping.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionPreprocessingConfig"},"type":{"type":"object","object":{"properties":{"transformationConfig":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Config"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cropConfig":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"CropConfig"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for layout-aware extraction preprocessing.","plainTextDescription":"Configuration for layout-aware extraction preprocessing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"JpgFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"JPEG image format.","plainTextDescription":"JPEG image format.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioSpecification"},"type":{"type":"object","object":{"properties":{"bitRate":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second.\n","plainTextDescription":"Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second.","example":[]}},"durationSeconds":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"Approximate duration of the audio, in seconds with up to two decimal digits (rounded up).\n","plainTextDescription":"Approximate duration of the audio, in seconds with up to two decimal digits (rounded up).","example":[]}},"numberOfChannels":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Number of audio channels in the audio stream.","plainTextDescription":"Number of audio channels in the audio stream.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Technical specifications for audio media items.","plainTextDescription":"Technical specifications for audio media items.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractDocumentLayoutAwareTextV2Config"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"TextOutputFormat"}}}}},"safety":"SAFE","documentation":{"example":[]}},"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"languages":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"}}}}},"safety":"UNSAFE","documentation":{"description":"List of OCR languages or scripts to use.","plainTextDescription":"List of OCR languages or scripts to use.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Configuration for v2 layout-aware document text extraction.","plainTextDescription":"Configuration for v2 layout-aware document text extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ExtractAudioOperation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Extracts the first audio stream from the video unchanged.","plainTextDescription":"Extracts the first audio stream from the video unchanged.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ImageOcrOperation"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrParameters"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Performs OCR (Optical Character Recognition) on an image.","plainTextDescription":"Performs OCR (Optical Character Recognition) on an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"AudioChannelLayout"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"numberOfChannels":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"NumberOfChannels"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The audio channel layout configuration.","plainTextDescription":"The audio channel layout configuration.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwarePreprocessingWrapper"},"type":{"type":"object","object":{"properties":{"layoutAware":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"LayoutAwareExtractionPreprocessingConfig"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for layout-aware preprocessing.","plainTextDescription":"Wrapper for layout-aware preprocessing.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageOrScript"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"language":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrLanguageWrapper"}}}},"script":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"OcrScriptWrapper"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Either a specific language or a script for OCR.","plainTextDescription":"Either a specific language or a script for OCR.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"PaletteInterpretation"},"type":{"type":"enum","enum":{"values":["GRAY","RGB","RGBA","CMYK","HLS"]}},"safety":"SAFE","documentation":{"description":"The palette interpretation of a band.","plainTextDescription":"The palette interpretation of a band.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ContrastRayleigh"},"type":{"type":"object","object":{"properties":{"sigma":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"description":"The scaling parameter for the Rayleigh distribution (0-1).","plainTextDescription":"The scaling parameter for the Rayleigh distribution (0-1).","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Applies Rayleigh distribution-based contrast adjustment.","plainTextDescription":"Applies Rayleigh distribution-based contrast adjustment.","example":[]}}],"errors":[{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmError"},"errorType":"INVALID_ARGUMENT","parameters":{"underlyingErrorType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"code":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A language model call failed during a media transformation.","plainTextDescription":"A language model call failed during a media transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationModelContextWindowExceeded"},"errorType":"INVALID_ARGUMENT","parameters":{"inputTokenCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxTokens":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The transformation input exceeded the model's maximum context window.","plainTextDescription":"The transformation input exceeded the model's maximum context window.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmPageRangeRequired"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set.\n","plainTextDescription":"Document extraction requires an explicit page range with both startPageInclusive and endPageExclusive set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"ConflictingMediaSetIdentifiers"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Client provided more than one of branch name, branch rid, or view rid as arguments. Only one may be specified.\n","plainTextDescription":"Client provided more than one of branch name, branch rid, or view rid as arguments. Only one may be specified.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSetOpenTransactionAlreadyExists"},"errorType":"CONFLICT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A transaction is already open on this media set and branch. A branch of a media set can only have one open transaction at a time.\n","plainTextDescription":"A transaction is already open on this media set and branch. A branch of a media set can only have one open transaction at a time.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"InvalidMediaItemRid"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}},"reason":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"invalidFieldName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"expectedFieldValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"actualFieldValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided media item RID is invalid.","plainTextDescription":"The provided media item RID is invalid.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemNotFound"},"errorType":"NOT_FOUND","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested media item could not be found, or the client token does not have access to it.","plainTextDescription":"The requested media item could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationDocumentExtractError"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error.\n","plainTextDescription":"Document extraction failed. This covers any failure during extraction, from a malformed document to a server-side error.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TemporaryMediaUploadUnknownFailure"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"An unknown error occurred, please try again, and if this continues please contact your Palantir representative.\n","plainTextDescription":"An unknown error occurred, please try again, and if this continues please contact your Palantir representative.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationImageTooLargeForOcr"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The image or document page dimensions exceeded the maximum supported by the OCR model.","plainTextDescription":"The image or document page dimensions exceeded the maximum supported by the OCR model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UnexpectedMetadataType"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API.\n","plainTextDescription":"Received an unexpected metadata type, this particular media item may use features that are not yet fully supported in the public API.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemImageUnparsable"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file cannot be parsed as an image.","plainTextDescription":"The file cannot be parsed as an image.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"InvalidMediaItemSchema"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media item does not match the schema of the media set.","plainTextDescription":"The media item does not match the schema of the media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationInvalidPageRange"},"errorType":"INVALID_ARGUMENT","parameters":{"startPageInclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"endPageExclusive":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"documentLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The supplied page range is invalid.","plainTextDescription":"The supplied page range is invalid.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmLayoutModelFailure"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"The layout or OCR model used as preprocessing for document extraction failed.","plainTextDescription":"The layout or OCR model used as preprocessing for document extraction failed.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationModelNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"modelId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested model is not supported for this transformation.","plainTextDescription":"The requested model is not supported for this transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"GetMediaItemRidByPathPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The token does not have permission to view paths in this media set.","plainTextDescription":"The token does not have permission to view paths in this media set.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaSetNotFound"},"errorType":"NOT_FOUND","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested media set could not be found, or the client token does not have access to it.","plainTextDescription":"The requested media set could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MissingMediaItemContent"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file has no bytes.","plainTextDescription":"The file has no bytes.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"underlyingErrorType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"code":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The caller does not have permission to run this media transformation.","plainTextDescription":"The caller does not have permission to run this media transformation.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmResponseParseError"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"The model response could not be parsed during document extraction.","plainTextDescription":"The model response could not be parsed during document extraction.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationNotFound"},"errorType":"NOT_FOUND","parameters":{},"documentation":{"description":"The requested transformation could not be found.","plainTextDescription":"The requested transformation could not be found.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemXmlUnparsable"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaItemXmlFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"MediaSets","localName":"MediaItemXmlFormat"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The document cannot be parsed due to an unrecognized XML structure.","plainTextDescription":"The document cannot be parsed due to an unrecognized XML structure.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MissingMediaItemPath"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given media set requires paths but no path was provided.","plainTextDescription":"The given media set requires paths but no path was provided.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemIsPasswordProtected"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file cannot be read because it is password protected.","plainTextDescription":"The file cannot be read because it is password protected.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationInputTooLarge"},"errorType":"REQUEST_ENTITY_TOO_LARGE","parameters":{},"documentation":{"description":"The transformation input is too large for the underlying model.","plainTextDescription":"The transformation input is too large for the underlying model.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemHasUnsupportedSecuritySettings"},"errorType":"INVALID_ARGUMENT","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The file cannot be read because it contains unsupported security settings (for example, public-key security handlers in a PDF).","plainTextDescription":"The file cannot be read because it contains unsupported security settings (for example, public-key security handlers in a PDF).","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TemporaryMediaUploadInsufficientPermissions"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Insufficient permissions to use this endpoint. This may be because that you are using a custom client instead of\nan official Palantir client library. If so, please try again using OSDK, Python Functions, or TypeScript\nFunctions V2.\n","plainTextDescription":"Insufficient permissions to use this endpoint. This may be because that you are using a custom client instead of\nan official Palantir client library. If so, please try again using OSDK, Python Functions, or TypeScript\nFunctions V2.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformedMediaItemNotFound"},"errorType":"NOT_FOUND","parameters":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested media item could not be found, or the client token does not have access to it.","plainTextDescription":"The requested media item could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationUnavailable"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested transformation is not currently available.","plainTextDescription":"The requested transformation is not currently available.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationVlmMultiPageRequestUnsupported"},"errorType":"INVALID_ARGUMENT","parameters":{"requestedPages":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxValidPageCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Document extraction only supports a single page per request.","plainTextDescription":"Document extraction only supports a single page per request.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"UnsupportedMetadata"},"errorType":"INTERNAL","parameters":{},"documentation":{"description":"A media item has an unsupported metadata type","plainTextDescription":"A media item has an unsupported metadata type","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"MediaItemRidAlreadyExists"},"errorType":"CONFLICT","parameters":{"mediaItemRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A media item with the specified RID already exists.","plainTextDescription":"A media item with the specified RID already exists.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationModelNotAvailable"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested model is not available or the caller does not have permission to use it.","plainTextDescription":"The requested model is not available or the caller does not have permission to use it.","example":[]}},{"locator":{"namespaceName":"MediaSets","localName":"TransformationMediaSizeExceeded"},"errorType":"REQUEST_ENTITY_TOO_LARGE","parameters":{"sizeInBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"long","long":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxSizeInBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"long","long":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The media item exceeds the maximum size supported by the transformation.","plainTextDescription":"The media item exceeds the maximum size supported by the transformation.","example":[]}}]}; diff --git a/packages/docs-spec-platform/src/generated/namespaces/OntologiesV1.ts b/packages/docs-spec-platform/src/generated/namespaces/OntologiesV1.ts index 819d875de..b5fdb2fd9 100644 --- a/packages/docs-spec-platform/src/generated/namespaces/OntologiesV1.ts +++ b/packages/docs-spec-platform/src/generated/namespaces/OntologiesV1.ts @@ -17,4 +17,4 @@ import type { Namespace } from "../../ir/Namespace.js"; // dprint-ignore -export const OntologiesV1: Namespace = {"name":"Ontologies","version":"v1","outputAuditVersions":"V3_ONLY","resources":[{"singleton":false,"documentation":{"description":"Ontologies are categorizations of data into real-world concepts. Those concepts are represented by object types, properties, link types, and action types. Together, these concepts form a descriptive object graph that links together all the key entities in an organization.\n\nFor more information, please refer to the [Ontology](/docs/foundry/ontology/overview/) user documentation.\n\n:::callout{theme=neutral title=Note}\nOntology changes are eventually consistent, and it may take few minutes for the API to reflect new Ontologies.\nAfter adding a new Ontology, the API may return an `OntologyNotFound` error for a few minutes.\n:::\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Ontology"},"pluralName":"Ontologies","operations":[{"name":"listOntologies","verb":"list","documentation":{"description":"Lists the Ontologies visible to the current user.\n","plainTextDescription":"Lists the Ontologies visible to the current user.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies","httpMethod":"GET","parameters":[],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"},{"apiName":"shared-ontology","displayName":"Shared ontology","description":"The ontology shared with our suppliers","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOntology","verb":"get","documentation":{"description":"Gets a specific ontology with the given Ontology RID.\n","plainTextDescription":"Gets a specific ontology with the given Ontology RID.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Ontology"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"This represents an object type within a Foundry Ontology. For more information, review the \n[Object Type](/docs/foundry/object-link-types/object-types-overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ObjectType"},"pluralName":"ObjectTypes","operations":[{"name":"listObjectTypes","verb":"list","documentation":{"description":"Lists the object types for the given Ontology.\n\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.\n","plainTextDescription":"Lists the object types for the given Ontology.\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","primaryKey":["employeeId"],"properties":{"employeeId":{"baseType":"Integer"},"fullName":{"baseType":"String"},"office":{"description":"The unique ID of the employee's primary assigned office","baseType":"String"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","baseType":"Date"}},"rid":"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"},{"apiName":"office","description":"A physical location (not including rented co-working spaces)","primaryKey":["officeId"],"properties":{"officeId":{"baseType":"String"},"address":{"description":"The office's physical address (not necessarily shipping address)","baseType":"String"},"capacity":{"description":"The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)","baseType":"Integer"}},"rid":"ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectType","verb":"get","documentation":{"description":"Gets a specific object type with the given API name.\n","plainTextDescription":"Gets a specific object type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes/{objectType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","primaryKey":["employeeId"],"properties":{"employeeId":{"baseType":"Integer"},"fullName":{"baseType":"String"},"office":{"description":"The unique ID of the employee's primary assigned office","baseType":"String"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","baseType":"Date"}},"rid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOutgoingLinkTypes","verb":"listOutgoingLinkTypes","documentation":{"description":"List the outgoing links for an object type.\n","plainTextDescription":"List the outgoing links for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager** application.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager application.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Flight"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned.","plainTextDescription":"The desired size of the page to be returned.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"originAirport","objectTypeApiName":"Airport","cardinality":"ONE","foreignKeyPropertyApiName":"originAirportId"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingLinkType","verb":"getOutgoingLinkType","documentation":{"description":"Get an outgoing link for an object type.\n","plainTextDescription":"Get an outgoing link for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager** application.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager application.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the outgoing link.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the outgoing link.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"directReport","objectTypeApiName":"Employee","cardinality":"MANY"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An action type represents a set of changes and logic that can be applied in the Ontology. Action types are \ncreated in the **Ontology Manager**. For more information, refer to the\n[action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ActionType"},"pluralName":"ActionTypes","operations":[{"name":"listActionTypes","verb":"list","documentation":{"description":"Lists the action types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the action types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actionTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"baseType":"Integer"},"newTitle":{"baseType":"String"},"newCompensation":{"baseType":"Decimal"}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},{"apiName":"move-office","description":"Update an office's physical location","parameters":{"officeId":{"baseType":"String"},"newAddress":{"description":"The office's new physical address (not necessarily shipping address)","baseType":"String"},"newCapacity":{"description":"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)","baseType":"Integer"}},"rid":"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionType","verb":"get","documentation":{"description":"Gets a specific action type with the given API name.\n","plainTextDescription":"Gets a specific action type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action type.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action type.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionTypeApiName","documentation":{"description":"The name of the action type in the API.\n","plainTextDescription":"The name of the action type in the API.","example":["promote-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"baseType":"Integer"},"newTitle":{"baseType":"String"},"newCompensation":{"baseType":"Decimal"}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Action represents one application of an action type. You may use them in the API to apply changes to the \nOntology. For more information, refer to the [action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Action"},"pluralName":"Actions","operations":[{"name":"applyAction","verb":"apply","documentation":{"description":"Applies an action using the given parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n","plainTextDescription":"Applies an action using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that parameter default values are not currently supported by\nthis endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/apply","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]},{"name":"applyActionBatch","verb":"applyBatch","documentation":{"description":"Applies multiple actions (of the same Action Type) using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and\n[notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint.\n","plainTextDescription":"Applies multiple actions (of the same Action Type) using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\nNote that parameter default values and\nnotifications are not currently supported by this endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"applyActionAsync","verb":"applyAsync","documentation":{"description":"Applies an action asynchronously using the given parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently\nsupported by this endpoint.\n","plainTextDescription":"Applies an action asynchronously using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that parameter default values are not currently\nsupported by this endpoint.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Represents a boolean value that restricts an endpoint to preview mode when set to true.\n","plainTextDescription":"Represents a boolean value that restricts an endpoint to preview mode when set to true.","example":[true]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"id":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367","operationType":"applyActionAsync","status":"RUNNING","stage":"RUNNING_SUBMISSION_CHECKS"}]}]},"body":{"type":"accepted","accepted":{"responseType":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"code":"202"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAsyncActionStatus","verb":"getOperationStatus","documentation":{"example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Represents a boolean value that restricts an endpoint to preview mode when set to true.\n","plainTextDescription":"Represents a boolean value that restricts an endpoint to preview mode when set to true.","example":[true]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response","plainTextDescription":"Success response","example":[{"id":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367","operationType":"applyActionAsync","status":"SUCCESSFUL","result":{"type":"success"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"validateAction","verb":"validate","documentation":{"description":"Validates if an action can be run with the given set of parameters.\nThe response contains the evaluation of parameters and **submission criteria**\nthat determine if the request is `VALID` or `INVALID`.\nFor performance reasons, validations will not consider existing objects or other data in Foundry.\nFor example, the uniqueness of a primary key or the existence of a user ID will not be checked.\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint. Unspecified parameters will be given a default value of `null`.\n","plainTextDescription":"Validates if an action can be run with the given set of parameters.\nThe response contains the evaluation of parameters and submission criteria\nthat determine if the request is VALID or INVALID.\nFor performance reasons, validations will not consider existing objects or other data in Foundry.\nFor example, the uniqueness of a primary key or the existence of a user ID will not be checked.\nNote that parameter default values are not currently supported by\nthis endpoint. Unspecified parameters will be given a default value of null.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyLogicAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/validate","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to validate. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to validate. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":"2","firstName":"Chuck","lastName":"Jones","age":17,"date":"2021-05-01","numbers":[1,2,3],"hasObjectSet":true,"objectSet":"ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623","reference":"Chuck","percentage":41.3,"differentObjectId":"2"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"result":"INVALID","submissionCriteria":[{"configuredFailureMessage":"First name can not match the first name of the referenced object.","result":"INVALID"}],"parameters":{"age":{"result":"INVALID","evaluatedConstraints":[{"type":"range","gte":18}],"required":true},"id":{"result":"VALID","evaluatedConstraints":[],"required":true},"date":{"result":"VALID","evaluatedConstraints":[],"required":true},"lastName":{"result":"VALID","evaluatedConstraints":[{"type":"oneOf","options":[{"displayName":"Doe","value":"Doe"},{"displayName":"Smith","value":"Smith"},{"displayName":"Adams","value":"Adams"},{"displayName":"Jones","value":"Jones"}],"otherValuesAllowed":true}],"required":true},"numbers":{"result":"VALID","evaluatedConstraints":[{"type":"arraySize","lte":4,"gte":2}],"required":true},"differentObjectId":{"result":"VALID","evaluatedConstraints":[{"type":"objectPropertyValue"}],"required":false},"firstName":{"result":"VALID","evaluatedConstraints":[],"required":true},"reference":{"result":"VALID","evaluatedConstraints":[{"type":"objectQueryResult"}],"required":false},"percentage":{"result":"VALID","evaluatedConstraints":[{"type":"range","lt":100,"gte":0}],"required":true},"objectSet":{"result":"VALID","evaluatedConstraints":[],"required":true},"attachment":{"result":"VALID","evaluatedConstraints":[],"required":false},"hasObjectSet":{"result":"VALID","evaluatedConstraints":[],"required":false},"multipleAttachments":{"result":"VALID","evaluatedConstraints":[{"type":"arraySize","gte":0}],"required":false}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using [Query Functions](/docs/foundry/functions/query-functions/).","example":[]},"component":{"namespaceName":"Ontologies","localName":"QueryType"},"pluralName":"QueryTypes","operations":[{"name":"listQueryTypes","verb":"list","documentation":{"description":"Lists the query types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the query types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/queryTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 100.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 100.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"baseType":"String","description":"The city to search for employees in","required":true}},"output":"Array>","rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"},{"apiName":"getAverageTenureOfEmployees","displayName":"Get Average Tenure","description":"Gets the average tenure of all employees","parameters":{"employees":{"baseType":"String","description":"An object set of the employees to calculate the average tenure of","required":true},"useMedian":{"baseType":"Boolean","description":"An optional flag to use the median instead of the mean, defaults to false","required":false}},"output":"Double","rid":"ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400","version":"2.1.1"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getQueryType","verb":"get","documentation":{"description":"Gets a specific query type with the given API name.\n","plainTextDescription":"Gets a specific query type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the query type. To find the API name, use the **List query types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the query type. To find the API name, use the List query types endpoint or\ncheck the Ontology Manager.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"baseType":"String","description":"The city to search for employees in","required":true}},"output":"Array>","rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using [Query Functions](/docs/foundry/functions/query-functions/).","example":[]},"component":{"namespaceName":"Ontologies","localName":"Query"},"pluralName":"Queries","operations":[{"name":"executeQuery","verb":"execute","documentation":{"description":"Executes a Query using the given parameters. Optional parameters do not need to be supplied.\n","plainTextDescription":"Executes a Query using the given parameters. Optional parameters do not need to be supplied.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the Query to execute.\n","plainTextDescription":"The API name of the Query to execute.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"attribution","documentation":{"description":"The Attribution to be used when executing this request.\n","plainTextDescription":"The Attribution to be used when executing this request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"city":"New York"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"value":["EMP546","EMP609","EMP989"]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Object is a data container for a specific instance of an [Object Type](/docs/foundry/object-link-types/object-types-overview/). For instance, the Employee object type may contain data about several employees, and each one is represented as a single Object.\n\n## Filter objects\n\nAnytime you request a list of objects using the List Objects endpoint, you can add filters to limit which objects you get back. Filters are given as query parameters of the form:\n\n```\nproperties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}\n```\n\nFor instance, the following filter will return only objects with a property called \"firstName\" that has the exact value of \"John\".\n\n```\nproperties.firstName.eq=John\n```\n\nProperty names in URLs are case-insensitive, and as a shortcut, you can write `p.` instead of `properties.`. The above example could also be written like this.\n\n```\np.firstname.eq=John\n```\n\n| Filter | Description | Valid property types | Example Usage |\n|----------|--------------------------|-------------------------------------------------------|------------------------------------|\n| contains | Array contains value | arrays | properties.names.contains=John |\n| eq | Exactly equal | all types except arrays and attachments | properties.firstName.eq=John |\n| neq | Not exactly equal | all types except arrays and attachments | properties.firstName.neq=John |\n| lt | Less than | date, timestamp, byte, integer, long, double, decimal | properties.age.lt=40 |\n| lte | Less than or equal to | date, timestamp, byte, integer, long, double, decimal | properties.age.lte=40 |\n| gt | Greater than | date, timestamp, byte, integer, long, double, decimal | properties.age.gt=40 |\n| gte | Greater than or equal to | date, timestamp, byte, integer, long, double, decimal | properties.age.gte=40 |\n| isNull | Value is null | all types except attachments | properties.firstName.isNull=false |\n\nIf multiple `contains` or `eq` filters are applied to the same property, then objects that have any of the given values for the specified property will be matched. If two range filters are applied to the same property (e.g. `lt` and `gte`), then only objects that match both constraints will be returned.\n\nAs a more complex example, the following filter will match people named John or Anna who were born in the 1980s, whose interests include tennis or golf, and who have a (non-null) street address. It is written on multiple lines for readability.\n\n```\n?p.firstName.eq=John\n&p.firstName.eq=Anna\n&p.birthDate.gte=1980-01-01\n&p.birthDate.lt=1990-01-01\n&p.interests.contains=tennis\n&p.interests.contains=golf\n&p.streetAddress.isNull=false\n```\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyObject"},"pluralName":"OntologyObjects","operations":[{"name":"listObjects","verb":"list","documentation":{"description":"Lists the objects for the given Ontology and object type.\n\nThis endpoint supports filtering objects.\nSee the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the objects for the given Ontology and object type.\nThis endpoint supports filtering objects.\nSee the Filtering Objects documentation for details.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","properties":{"id":50030,"firstName":"John","lastName":"Doe"}},{"rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","properties":{"id":20090,"firstName":"John","lastName":"Haymore"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObject","verb":"get","documentation":{"description":"Gets a specific object with the given primary key.\n","plainTextDescription":"Gets a specific object with the given primary key.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the requested object. To look up the expected primary key for your object type, use the\n`Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested object. To look up the expected primary key for your object type, use the\nGet object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","properties":{"id":50030,"firstName":"John","lastName":"Doe"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listLinkedObjects","verb":"listLinkedObjects","documentation":{"description":"Lists the linked objects for a specific object and the given link type.\n\nThis endpoint supports filtering objects.\nSee the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the linked objects for a specific object and the given link type.\nThis endpoint supports filtering objects.\nSee the Filtering Objects documentation for details.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object from which the links originate. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","properties":{"id":80060,"firstName":"Anna","lastName":"Smith"}},{"rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","properties":{"id":51060,"firstName":"James","lastName":"Matthews"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getLinkedObject","verb":"getLinkedObject","documentation":{"description":"Get a specific linked object that originates from another object. If there is no link between the two objects,\nLinkedObjectNotFound is thrown.\n","plainTextDescription":"Get a specific linked object that originates from another object. If there is no link between the two objects,\nLinkedObjectNotFound is thrown.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**.","plainTextDescription":"The API name of the object from which the links originate. To find the API name, use the List object types endpoint or check the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the link originates. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the link originates. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkedObjectPrimaryKey","documentation":{"description":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the Get object type endpoint (passing the linked object type) or the Ontology Manager.","example":[80060]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","properties":{"id":80060,"firstName":"Anna","lastName":"Smith"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchObjects","verb":"search","documentation":{"description":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| prefix | The provided property starts with the provided term. | string |\n| phrase | The provided property contains the provided term as a substring. | string |\n| anyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| allTerms | The provided property contains all the terms separated by whitespace. | string |\n\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\n","plainTextDescription":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| prefix | The provided property starts with the provided term. | string |\n| phrase | The provided property contains the provided term as a substring. | string |\n| anyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| allTerms | The provided property contains all the terms separated by whitespace. | string |\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'\"~). Periods (.) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/search","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The type of the requested objects.","plainTextDescription":"The type of the requested objects.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"query":{"not":{"field":"properties.age","eq":21}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"properties":{"lastName":"smith","firstName":"john","age":21},"rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"aggregateObjects","verb":"aggregate","documentation":{"description":"Perform functions on object fields in the specified ontology and object type.\n","plainTextDescription":"Perform functions on object fields in the specified ontology and object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The type of the object to aggregate on.","plainTextDescription":"The type of the object to aggregate on.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"aggregation":[{"type":"min","field":"properties.tenure","name":"min_tenure"},{"type":"avg","field":"properties.tenure","name":"avg_tenure"}],"query":{"not":{"field":"properties.name","eq":"john"}},"groupBy":[{"field":"properties.startDate","type":"range","ranges":[{"gte":"2020-01-01","lt":"2020-06-01"}]},{"field":"properties.city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"properties.startDate":{"gte":"2020-01-01","lt":"2020-06-01"},"properties.city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"properties.startDate":{"gte":"2020-01-01","lt":"2020-06-01"},"properties.city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Attachment is a file that acts like a parameter of an object. Attachments are uploaded as temporary files \nand attached to objects via actions. Attachments are configured in the **Ontology Manager**. For more information, \nplease checkout the [Upload attachments](/docs/foundry/action-types/upload-attachments/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Attachment"},"pluralName":"Attachments","operations":[{"name":"uploadAttachment","verb":"upload","documentation":{"description":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n","plainTextDescription":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.","example":[]},"releaseStage":"STABLE","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/attachments/upload","httpMethod":"POST","parameters":[{"name":"Content-Length","documentation":{"description":"The size in bytes of the file content being uploaded.","plainTextDescription":"The size in bytes of the file content being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentLength"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Type","documentation":{"description":"The media type of the file being uploaded.","plainTextDescription":"The media type of the file being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentType"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"The name of the file being uploaded.","plainTextDescription":"The name of the file being uploaded.","example":["My Image.jpeg"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Attachment"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentContent","verb":"read","documentation":{"description":"Get the content of an attachment.\n","plainTextDescription":"Get the content of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/attachments/{attachmentRid}/content","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachment","verb":"get","documentation":{"description":"Get the metadata of an attachment.\n","plainTextDescription":"Get the metadata of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/attachments/{attachmentRid}","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Attachment"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]}],"components":[{"locator":{"namespaceName":"Ontologies","localName":"TableRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry table.","plainTextDescription":"The RID of a Foundry table.","example":["ri.tables.main.table.beb574f7-019c-4a01-abd1-ff3c97bfaec8"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"}}}},"prefix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"}}}},"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"}}}},"allTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"}}}},"phrase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"}}}},"anyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface property implementations of that object type.","plainTextDescription":"Map from object type to the interface property implementations of that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of an input to a function.\n","plainTextDescription":"The name of an input to a function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the property is backed by a restricted view that does not support property securities.","plainTextDescription":"Indicates the property is backed by a restricted view that does not support property securities.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"},"type":{"type":"object","object":{"properties":{"center":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"}}},"safety":"UNSAFE","documentation":{"example":[]}},"distance":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Distance"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The coordinate point to use as the center of the distance query.\n","plainTextDescription":"The coordinate point to use as the center of the distance query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeReferences":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a parameter against the configured constraints.","plainTextDescription":"Represents the validity of a parameter against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the PropertyType","plainTextDescription":"The API name of the PropertyType","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"},"type":{"type":"object","object":{"properties":{"position":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Position"}}},"safety":"UNSAFE","documentation":{"example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The underlying data values pointed to by a GeotimeSeriesReference.","plainTextDescription":"The underlying data values pointed to by a GeotimeSeriesReference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current time argument in a logic rule.","plainTextDescription":"Represents the current time argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionMode"},"type":{"type":"enum","enum":{"values":["ASYNC","RUN","VALIDATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types that have been modified within a scenario.\n","plainTextDescription":"The object types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an approximate number of distinct values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","plainTextDescription":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadOntologyMetadataRequest"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","plainTextDescription":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version corresponding to a codex template.","plainTextDescription":"The version corresponding to a codex template.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have been edited within the scenario.","plainTextDescription":"The list of objects that have been edited within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have been edited within a scenario for a given object type.\n\nThe Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName`\nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The objects that have been edited within a scenario for a given object type.\nThe Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched intervals must occur in order.","plainTextDescription":"If true, the matched intervals must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying all the rules in the query\n","plainTextDescription":"Matches intervals satisfying all the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a struct field in the Ontology.","plainTextDescription":"The name of a struct field in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"timeSeriesSyncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the time series.\n","plainTextDescription":"The set of properties that are bound to the time series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a time series sync, providing values for time-dependent properties.\n","plainTextDescription":"An object type datasource backed by a time series sync, providing values for time-dependent properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"},"type":{"type":"object","object":{"properties":{"ontology":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BranchMetadata"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with an api name matching the given string predicate.","plainTextDescription":"Returns action types with an api name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`.","plainTextDescription":"Represents the API POST body when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequest"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","plainTextDescription":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed \"Other\" value** toggle in the **Ontology Manager**.","plainTextDescription":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the Allowed \"Other\" value toggle in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter has a manually predefined set of options.\n","plainTextDescription":"The parameter has a manually predefined set of options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Greater than or equal.","plainTextDescription":"Greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Less than or equal.","plainTextDescription":"Less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Bounds on the size of an array-typed parameter.","plainTextDescription":"Bounds on the size of an array-typed parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"style":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"}}},"safety":"SAFE","documentation":{"example":[]}},"currencyCode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)\n","plainTextDescription":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"},"type":{"type":"object","object":{"properties":{"directSourceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.\n","plainTextDescription":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Parameter"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action or query.","plainTextDescription":"Details about a parameter of an action or query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter`, whose value type is\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter, whose value type is\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"},"type":{"type":"object","object":{"properties":{"numberType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for numeric formatting options.","plainTextDescription":"Wrapper for numeric formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the minimum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.\n","plainTextDescription":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A message containing link updates for a subscription.","plainTextDescription":"A message containing link updates for a subscription.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The numeric value of the time offset. Negative values indicate the past, positive values the future.\n","plainTextDescription":"The numeric value of the time offset. Negative values indicate the past, positive values the future.","example":[-7]}},"timeUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A point in time specified relative to query execution time.","plainTextDescription":"A point in time specified relative to query execution time.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they are revertible.","plainTextDescription":"Returns action types based on whether they are revertible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"},"type":{"type":"enum","enum":{"values":["STANDARD","SCIENTIFIC","ENGINEERING","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Number notation style options:\n- STANDARD: Regular number display (\"1,234\")\n- SCIENTIFIC: Scientific notation (\"1.234E3\")\n- ENGINEERING: Engineering notation (\"1.234E3\")\n- COMPACT: Compact notation (\"1.2K\")\n","plainTextDescription":"Number notation style options:\n\nSTANDARD: Regular number display (\"1,234\")\nSCIENTIFIC: Scientific notation (\"1.234E3\")\nENGINEERING: Engineering notation (\"1.234E3\")\nCOMPACT: Compact notation (\"1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the property in the API. To find the API name for your property, use the `Get object type`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the property in the API. To find the API name for your property, use the Get object type\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"description":"The suggested visibility of the object type.","plainTextDescription":"The suggested visibility of the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Represents a filter used on properties.\n\nEndpoints that accept this supports optional parameters that have the form:\n`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects.\nFor instance, you may use `properties.firstName.eq=John` to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\n\nThe following are a list of supported property filters:\n\n- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties\n that have at least one of the provided values. If multiple query parameters are provided, then objects\n that have any of the given values for the specified property will be matched.\n- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided\n property. If multiple query parameters are provided, then objects that have any of the given values\n will be matched. For instance, if the user provides a request by doing\n `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property\n of either John or Anna will be matched. This filter is supported on all property types except Arrays.\n- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values.\n Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values\n will be excluded from the result.\n- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt`\n `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater\n than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\n- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null.\n This filter is supported on all property types.\n","plainTextDescription":"Represents a filter used on properties.\nEndpoints that accept this supports optional parameters that have the form:\nproperties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString} to filter the returned objects.\nFor instance, you may use properties.firstName.eq=John to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\nThe following are a list of supported property filters:\n\nproperties.{propertyApiName}.contains - supported on arrays and can be used to filter array properties\nthat have at least one of the provided values. If multiple query parameters are provided, then objects\nthat have any of the given values for the specified property will be matched.\nproperties.{propertyApiName}.eq - used to filter objects that have the exact value for the provided\nproperty. If multiple query parameters are provided, then objects that have any of the given values\nwill be matched. For instance, if the user provides a request by doing\n?properties.firstName.eq=John&properties.firstName.eq=Anna, then objects that have a firstName property\nof either John or Anna will be matched. This filter is supported on all property types except Arrays.\nproperties.{propertyApiName}.neq - used to filter objects that do not have the provided property values.\nSimilar to the eq filter, if multiple values are provided, then objects that have any of the given values\nwill be excluded from the result.\nproperties.{propertyApiName}.lt, properties.{propertyApiName}.lte, properties.{propertyApiName}.gt\nproperties.{propertyApiName}.gte - represent less than, less than or equal to, greater than, and greater\nthan or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\nproperties.{propertyApiName}.isNull - used to filter objects where the provided property is (or is not) null.\nThis filter is supported on all property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Icon"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"blueprint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","plainTextDescription":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \n \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the derived property that will be returned.\n","plainTextDescription":"The name of the derived property that will be returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Ontology"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the `List shared property types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the List shared property types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the webhook with the given rid.","plainTextDescription":"Returns action types which reference the webhook with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only *properties*, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.\n","plainTextDescription":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only properties, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioRequest"},"type":{"type":"object","object":{"properties":{"base":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for creating an ontology scenario.","plainTextDescription":"The request payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"allOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"}}}},"match":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"}}}},"anyOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"}}}},"prefixOnLastToken":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"}}}},"fuzzy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Sub-rule used for evaluating an IntervalQuery","plainTextDescription":"Sub-rule used for evaluating an IntervalQuery","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a \nvariety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a\nvariety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A reference to an Ontology object property with the form `properties.{propertyApiName}`.","plainTextDescription":"A reference to an Ontology object property with the form properties.{propertyApiName}.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A reference to a UniqueIdentifierArgument linkId defined for this action type.\n","plainTextDescription":"A reference to a UniqueIdentifierArgument linkId defined for this action type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the action type in the API. To find the API name for your Action Type, use the `List action types`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the action type in the API. To find the API name for your Action Type, use the List action types\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"},"type":{"type":"object","object":{"properties":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}},"tense":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A datetime expressed as an offset from the current time.","plainTextDescription":"A datetime expressed as an offset from the current time.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"},"type":{"type":"object","object":{"properties":{"shouldLoadObjectRids":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of \nmilliseconds to the execution time, and should be avoided where not needed.\n","plainTextDescription":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of\nmilliseconds to the execution time, and should be avoided where not needed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Optional features to toggle when generating the object loading response.\n","plainTextDescription":"Optional features to toggle when generating the object loading response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.\n","plainTextDescription":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceObjectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructType"},"type":{"type":"object","object":{"properties":{"structFieldTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"mainValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A single struct field's mapping where `apiName` is the name of a struct field.\n","plainTextDescription":"A single struct field's mapping where apiName is the name of a struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"}}}},"user":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a parameter whose name matches the given string predicate.","plainTextDescription":"Returns action types with a parameter whose name matches the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"},"type":{"type":"object","object":{"properties":{"formatStyle":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"}}},"safety":"UNSAFE","documentation":{"example":[]}},"precision":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"}}}}},"safety":"SAFE","documentation":{"example":[]}},"baseValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numeric values representing time durations.\n- Human readable: 3661 seconds displays as \"1h 1m 1s\"\n- Timecode: 3661 seconds displays as \"01:01:01\"\n","plainTextDescription":"Format numeric values representing time durations.\n\nHuman readable: 3661 seconds displays as \"1h 1m 1s\"\nTimecode: 3661 seconds displays as \"01:01:01\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be within the defined range.\n","plainTextDescription":"The parameter value must be within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set \nby removing the request from subsequent ObjectSetStreamSubscribeRequests.\n","plainTextDescription":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set\nby removing the request from subsequent ObjectSetStreamSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayTimezone":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for timestamp property values.","plainTextDescription":"Formatting configuration for timestamp property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object locators to report link changes on.","plainTextDescription":"A list of object locators to report link changes on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface-to-object-type mapping for that object type.","plainTextDescription":"Map from object type to the interface-to-object-type mapping for that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"},"type":{"type":"enum","enum":{"values":["DAYS","MONTHS","QUARTERS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Negates a numeric value.\n","plainTextDescription":"Negates a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values of the object at the time of creation.\nMaps property API names to their values.\n","plainTextDescription":"The property values of the object at the time of creation.\nMaps property API names to their values.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`foreignKeyPropertyApiName` is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.\n","plainTextDescription":"foreignKeyPropertyApiName is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"scenarioReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ScenarioReferenceType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"geohash":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeohashType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Action parameters.\n","plainTextDescription":"A union of all the types supported by Ontology Action parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid UUID (Universally Unique Identifier).","plainTextDescription":"The string must be a valid UUID (Universally Unique Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"},"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\n`List ontologies` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"rolling":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"}}}},"periodic":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"}}}},"cumulative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.\n","plainTextDescription":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.\n","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified numeric range.\n","plainTextDescription":"The parameter value must fall within the specified numeric range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"structField":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"}}}},"propertyWithLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"}}}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"}}}},"primaryKeyProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An identifier used to select properties or struct fields.","plainTextDescription":"An identifier used to select properties or struct fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Randomly generated identifier for an object type's datasource.\n","plainTextDescription":"Randomly generated identifier for an object type's datasource.","example":["ri.ontology.main.datasource.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"},"type":{"type":"object","object":{"properties":{"selectedObjects":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.\n","plainTextDescription":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"},"type":{"type":"object","object":{"properties":{"minimumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"uniqueValues":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"valueConstraint":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"structFields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a singleton struct parameter.","plainTextDescription":"Represents the validity of a singleton struct parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponse"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the property values of the object.","plainTextDescription":"A map of the property values of the object.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Queries support either a vector matching the embedding model defined on the property, or text that is \nautomatically embedded.\n","plainTextDescription":"Queries support either a vector matching the embedding model defined on the property, or text that is\nautomatically embedded.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"},"type":{"type":"object","object":{"properties":{"streamRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry stream.","plainTextDescription":"An object type datasource backed by a Foundry stream.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"relativeStartTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"relativeEndTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"timeZoneId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.\n","plainTextDescription":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.","example":["America/New_York"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.\n\nExamples:\n- Last 7 days: relativeStartTime = {value: -7, timeUnit: DAY}, relativeEndTime = {value: 0, timeUnit: DAY}\n- This month: relativeStartTime = {value: 0, timeUnit: MONTH}, relativeEndTime = {value: 1, timeUnit: MONTH}\n","plainTextDescription":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.\nExamples:\n\nLast 7 days: relativeStartTime = {value: -7, timeUnit: DAY}, relativeEndTime = {value: 0, timeUnit: DAY}\nThis month: relativeStartTime = {value: 0, timeUnit: MONTH}, relativeEndTime = {value: 1, timeUnit: MONTH}","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"}}}},"doesNotIntersectBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"}}}},"relativeDateRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"}}}},"wildcard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"}}}},"withinDistanceOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"}}}},"withinBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"}}}},"intersectsBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"}}}},"containsAllTermsInOrderPrefixLastTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"}}}},"containsAllTermsInOrder":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"}}}},"withinPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"}}}},"intersectsPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"}}}},"in":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InQuery"}}}},"doesNotIntersectPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"}}}},"containsAllTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"}}}},"containsAnyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"}}}},"interval":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"}}}},"geoShapeV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"}}}},"startsWith":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Property"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyPropertyId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"},"type":{"type":"object","object":{"properties":{"minimumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maximumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappings":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappingsV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. An `interfaceToObjectTypeMappings` field is \noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\n\nThe `interfaceToObjectTypeMappings` field contains mappings from `SharedPropertyTypeApiName`s on the interface(s) to \n`PropertyApiName` for properties on the object(s).\n\nThe `interfaceToObjectTypeMappingsV2` field contains mappings from `InterfacePropertyApiName`s on the\ninterface(s) to `InterfacePropertyTypeImplementation` for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is\noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\nThe interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to\nPropertyApiName for properties on the object(s).\nThe interfaceToObjectTypeMappingsV2 field contains mappings from InterfacePropertyApiNames on the\ninterface(s) to InterfacePropertyTypeImplementation for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` \nmust be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either field or propertyIdentifier\nmust be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the struct parameter field.\n","plainTextDescription":"The unique identifier of the struct parameter field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds least of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds least of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"stringFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"}}}},"localizedFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.\n","plainTextDescription":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where at least one query is satisfied. An empty list matches no action types.","plainTextDescription":"Returns action types where at least one query is satisfied. An empty list matches no action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentMetadataResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"single":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}},"multiple":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The attachment metadata response","plainTextDescription":"The attachment metadata response","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"},"type":{"type":"object","object":{"properties":{"restrictedViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry restricted view.\n","plainTextDescription":"An object type datasource backed by a Foundry restricted view.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}},"filterLinkTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}}}},"safety":"SAFE","documentation":{"description":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.\n","plainTextDescription":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a direct-write source backing an object type.\n","plainTextDescription":"The RID of a direct-write source backing an object type.","example":["ri.ontology.main.direct-source.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the InterfacePropertyType.","plainTextDescription":"A short text that describes the InterfacePropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.\n","plainTextDescription":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"\n","plainTextDescription":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings required to access the property value. \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings required to access the property value.\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Performs both apply reducers and extract main value to return the reduced main value.","plainTextDescription":"Performs both apply reducers and extract main value to return the reduced main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"},"type":{"type":"object","object":{"properties":{"memberTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"},"type":{"type":"object","object":{"properties":{"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the main value of a struct as configured in the ontology.","plainTextDescription":"Returns the main value of a struct as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"},"type":{"type":"enum","enum":{"values":["PERCENTAGE","PER_MILLE","BASIS_POINTS"]}},"safety":"SAFE","documentation":{"description":"Ratio format options for displaying proportional values:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix\n","plainTextDescription":"Ratio format options for displaying proportional values:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"\n","plainTextDescription":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"","example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"\n","plainTextDescription":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"},"type":{"type":"object","object":{"properties":{"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\n`List object types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\nList object types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesV2Response"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponse"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the title property of an object type which is present on all object types.","plainTextDescription":"Specifies the title property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the sum of values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"},"type":{"type":"object","object":{"properties":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via the field of a local struct property.","plainTextDescription":"An implementation of an interface property via the field of a local struct property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSet"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"},"type":{"type":"enum","enum":{"values":["VALIDATE_ONLY","VALIDATE_AND_EXECUTE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `VALIDATE_AND_EXECUTE`.","plainTextDescription":"If not specified, defaults to VALIDATE_AND_EXECUTE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The current evaluation time itself. Carries no fields.","plainTextDescription":"The current evaluation time itself. Carries no fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"},"type":{"type":"object","object":{"properties":{"objects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Predefined localized formatting options.","plainTextDescription":"Predefined localized formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value.","plainTextDescription":"Returns objects where the specified field is greater than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"},"type":{"type":"object","object":{"properties":{"selectedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single link change between two objects.","plainTextDescription":"Represents a single link change between two objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series sync.","plainTextDescription":"The RID identifying a time series sync.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"}}}},"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"}}}},"editOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).\n","plainTextDescription":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"},"type":{"type":"enum","enum":{"values":["DAYS","HOURS","MINUTES","SECONDS","AUTO"]}},"safety":"SAFE","documentation":{"description":"Specifies the maximum precision to apply when formatting a duration.","plainTextDescription":"Specifies the maximum precision to apply when formatting a duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `oneOf` | The struct parameter field has a manually predefined set of options. |\n| `range` | The struct parameter field value must be within the defined range. |\n| `stringLength` | The struct parameter field value must have a length within the defined range. |\n| `stringRegexMatch` | The struct parameter field value must match a predefined regular expression. |\n| `objectQueryResult` | The struct parameter field value must be the primary key of an object found within an object set. |\n","plainTextDescription":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| oneOf | The struct parameter field has a manually predefined set of options. |\n| range | The struct parameter field value must be within the defined range. |\n| stringLength | The struct parameter field value must have a length within the defined range. |\n| stringRegexMatch | The struct parameter field value must match a predefined regular expression. |\n| objectQueryResult | The struct parameter field value must be the primary key of an object found within an object set. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified date or timestamp range.","plainTextDescription":"The parameter value must fall within the specified date or timestamp range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to local property).","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to local property).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"},"type":{"type":"object","object":{"properties":{"mainValueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The fields which comprise the main value of the struct.","plainTextDescription":"The fields which comprise the main value of the struct.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must have a length within the defined range.\n*This range is always inclusive.*\n","plainTextDescription":"The parameter value must have a length within the defined range.\nThis range is always inclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"},"type":{"type":"object","object":{"properties":{"linkId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}}}},"safety":"SAFE","documentation":{"description":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID. \nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.\n","plainTextDescription":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID.\nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Represents a unique identifier argument in a logic rule.","plainTextDescription":"Represents a unique identifier argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\n\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"}}}},"length":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"}}}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"}}}},"uuid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"}}}},"enum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"},"type":{"type":"enum","enum":{"values":["SECOND","MINUTE","HOUR","DAY","WEEK"]}},"safety":"SAFE","documentation":{"description":"Time unit for relative datetime offsets.","plainTextDescription":"Time unit for relative datetime offsets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains the provided value as a substring.","plainTextDescription":"Returns objects where the specified field contains the provided value as a substring.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property type that can be shared across object types.","plainTextDescription":"A property type that can be shared across object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'\n","plainTextDescription":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the primary key of an object found within an object set.\n","plainTextDescription":"The parameter value must be the primary key of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time range for a time series query.\n","plainTextDescription":"A relative time range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.\n","plainTextDescription":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which contain a logic rule of the given type.","plainTextDescription":"Returns action types which contain a logic rule of the given type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A user-specified alias for an aggregation metric name.","plainTextDescription":"A user-specified alias for an aggregation metric name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"},"type":{"type":"object","object":{"properties":{"entityType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object type or interface type API name.\n","plainTextDescription":"An object type or interface type API name.","example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts an object set to a specified object type or interface type API name. Any object whose object type does \nnot match the object type provided or implement the interface type provided will be dropped from the resulting \nobject set.\n","plainTextDescription":"Casts an object set to a specified object type or interface type API name. Any object whose object type does\nnot match the object type provided or implement the interface type provided will be dropped from the resulting\nobject set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on \nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRange"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The request to encrypt a plaintext value into a CipherText value.\n","plainTextDescription":"The request to encrypt a plaintext value into a CipherText value.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"definition":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The `definition` carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.\n","plainTextDescription":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The definition carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"},"type":{"type":"object","object":{"properties":{"conjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"disjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerConjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerDisjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"All marking requirements applicable to a property value.","plainTextDescription":"All marking requirements applicable to a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"},"type":{"type":"object","object":{"properties":{"ratioType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as a ratio with different scaling factors and suffixes:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")\n","plainTextDescription":"Display the value as a ratio with different scaling factors and suffixes:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"}}}},"createOrModifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"}}}},"batchedFunction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"}}}},"createOrModifyObjectV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"}}}},"deleteInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"}}}},"function":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}}},"createInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"}}}},"createInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A detailed operation for an Action","plainTextDescription":"A detailed operation for an Action","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have a notification.","plainTextDescription":"Returns action types based on whether they have a notification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in the following format.\n\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| [Attachment](/docs/foundry/api/v2/ontologies-v2-resources/attachment-properties/attachment-property-basics/) | JSON encoded `AttachmentProperty` object | `{\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"}` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` | \n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| Float | number | `3.14159265` |\n| GeoPoint | geojson | `{\"type\":\"Point\",\"coordinates\":[102.0,0.5]}` |\n| GeoShape | geojson | `{\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| [MediaReference](/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}}` |\n| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{\"value\": 10, \"propertySecurityIndex\" : 5}` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n| [Timeseries](/docs/foundry/api/v2/ontologies-v2-resources/time-series-properties/time-series-property-basics/) | JSON encoded `TimeseriesProperty` object or seriesId string | `{\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"}` or `{\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"}` or `\"wellPressureSeriesId\"`| |\n| Vector | array | `[0.1, 0.3, 0.02, 0.05 , 0.8, 0.4]` |\n\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.\n","plainTextDescription":"Represents the value of a property in the following format.\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | JSON encoded AttachmentProperty object | {\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"} |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| Float | number | 3.14159265 |\n| GeoPoint | geojson | {\"type\":\"Point\",\"coordinates\":[102.0,0.5]} |\n| GeoShape | geojson | {\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| MediaReference| JSON encoded MediaReference object | {\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}} |\n| Secured Property Value | JSON encoded SecuredPropertyValue object | {\"value\": 10, \"propertySecurityIndex\" : 5} |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |\n| Timeseries | JSON encoded TimeseriesProperty object or seriesId string | {\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"} or {\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"} or \"wellPressureSeriesId\"| |\n| Vector | array | [0.1, 0.3, 0.02, 0.05 , 0.8, 0.4] |\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"aggregate":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"searchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"}}}},"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"}}}},"intersect":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"}}}},"withProperties":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"}}}},"interfaceLinkSearchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"}}}},"nearestNeighbors":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"}}}},"asType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"}}}},"methodInput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"}}}},"filter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"}}}},"interfaceBase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"}}}},"asBaseObjectTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"}}}},"base":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the definition of an `ObjectSet` in the `Ontology`.","plainTextDescription":"Represents the definition of an ObjectSet in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"},"type":{"type":"object","object":{"properties":{"errors":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Arg"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"}}}},"removeLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"},"type":{"type":"object","object":{"properties":{"minimumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"applyReducersAndExtractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"}}}},"applyReducers":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"}}}},"extractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"}}}},"noLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The load level of the property:\n- APPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\n- EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\n- APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\n- NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.\n","plainTextDescription":"The load level of the property:\n\nAPPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\nEXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\nAPPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\nNO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"},"type":{"type":"object","object":{"properties":{"when":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.\n","plainTextDescription":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object parameter property argument in a logic rule.","plainTextDescription":"Represents an object parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The user's local timezone.","plainTextDescription":"The user's local timezone.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the interface type with the given rid.","plainTextDescription":"Returns action types which edit the interface type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.\n","plainTextDescription":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the link type with the given rid.","plainTextDescription":"Returns action types which edit the link type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"qos":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QosError"}}}},"success":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"},"type":{"type":"enum","enum":{"values":["EXPERIMENTAL","ACTIVE","DEPRECATED","EXAMPLE"]}},"safety":"SAFE","documentation":{"description":"Filter action types by status.","plainTextDescription":"Filter action types by status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Number of points in each window.","plainTextDescription":"Number of points in each window.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a column in a tabular datasource.","plainTextDescription":"The name of a column in a tabular datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Affix"},"type":{"type":"object","object":{"properties":{"prefix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"postfix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"An allowed configured value for a parameter within an action.","plainTextDescription":"An allowed configured value for a parameter within an action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.\n","plainTextDescription":"A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DecryptionResult"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value.","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatBasisPoints"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"\n","plainTextDescription":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Polygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Polygon"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the Geotime series.\n","plainTextDescription":"The set of properties that are bound to the Geotime series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.\n","plainTextDescription":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a static argument in a logic rule.","plainTextDescription":"Represents a static argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct list parameter field argument in a logic rule.","plainTextDescription":"Represents a struct list parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DataValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Attachment | string | `\"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` |\n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| EntrySet | array of JSON objects | `[{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}]` |\n| Float | number | `3.14159265` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| Marking | string | `\"MU\"` |\n| Null | null | `null` |\n| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z` |\n| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `\"EMP1234\"` |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| `{\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"}` |\n| Ontology Object Type Reference | string of the object type's api name | `\"Employee\"` |\n| Scenario Reference | string of the scenario RID | `\"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\"` |\n| Set | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object | `{\"name\": \"John Doe\", \"age\": 42}` |\n| TwoDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]}` |\n| ThreeDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]}` |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n","plainTextDescription":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | string | \"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\" |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| EntrySet | array of JSON objects | [{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}] |\n| Float | number | 3.14159265 |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| Marking | string | \"MU\" |\n| Null | null | null |\n| Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z |\n| Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or \"EMP1234\" |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| {\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"} |\n| Ontology Object Type Reference | string of the object type's api name | \"Employee\" |\n| Scenario Reference | string of the scenario RID | \"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\" |\n| Set | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object | {\"name\": \"John Doe\", \"age\": 42} |\n| TwoDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]} |\n| ThreeDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[".*fo?o*"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n - `.` matches any character.\n - `?` repeats the previous character 0 or 1 times.\n - `+` repeats the previous character 1 or more times.\n - `*` repeats the previous character 0 or more times.\n - `{}` defines the minimum and maximum number of times the preceding character can repeat. `{2}` means the\n previous character must repeat only twice, `{2,}` means the previous character must repeat at least twice,\n and `{2,4}` means the previous character must repeat between 2-4 times.\n - `|` is the OR operator.\n - `()` forms a group within an expression such that the group can be treated as a single character.\n - `[]` matches a single one of the characters contained inside the brackets, meaning [abc] matches `a`, `b` or\n `c`. Unless `-` is the first character or escaped with `\\` (in which case it is treated as a normal character),\n `-` can be used inside the bracket to create a range of characters, meaning [a-c] matches `a`, `b`, or `c`.\n If the character sequence inside the brackets begins with `^`, the set of characters is negated, meaning\n [^abc] does not match `a`, `b`, or `c`. Otherwise, `^` is treated as a normal character.\n - `\"` creates groups of string literals.\n - `\\` is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s \n and \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word \n characters respectively.\n\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n\n. matches any character.\n? repeats the previous character 0 or 1 times.\n+ repeats the previous character 1 or more times.\n* repeats the previous character 0 or more times.\n{} defines the minimum and maximum number of times the preceding character can repeat. {2} means the\nprevious character must repeat only twice, {2,} means the previous character must repeat at least twice,\nand {2,4} means the previous character must repeat between 2-4 times.\n| is the OR operator.\n() forms a group within an expression such that the group can be treated as a single character.\n[] matches a single one of the characters contained inside the brackets, meaning [abc] matches a, b or\nc. Unless - is the first character or escaped with \\ (in which case it is treated as a normal character),\n- can be used inside the bracket to create a range of characters, meaning [a-c] matches a, b, or c.\nIf the character sequence inside the brackets begins with ^, the set of characters is negated, meaning\n[^abc] does not match a, b, or c. Otherwise, ^ is treated as a normal character.\n\" creates groups of string literals.\n\\ is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s\nand \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word\ncharacters respectively.\n\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyVersion"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":["0000000d-2acf-537c-a228-3a9fe3cdc523"]}},{"locator":{"namespaceName":"Ontologies","localName":"QualifiedTimeseriesProperty"},"type":{"type":"object","object":{"properties":{"seriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"syncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by multiple time series syncs.","plainTextDescription":"The representation of a time series property backed by multiple time series syncs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}},"regex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","plainTextDescription":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Message returned when the value does not match the pattern.","plainTextDescription":"Message returned when the value does not match the pattern.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.\n","plainTextDescription":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"propertyMarkingSummary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"}}}},"unsupportedPolicy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"}}}},"errorComputingSecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.\n","plainTextDescription":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"},"type":{"type":"object","object":{"properties":{"datasetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Datasets","localName":"DatasetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry dataset.\n","plainTextDescription":"An object type datasource backed by a Foundry dataset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}},"scenarioRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"referenceSet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectLoadingResponseOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`branch` identifies the Foundry branch. `scenarioRid` identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, `branch` must identify that non-default base branch.\n","plainTextDescription":"branch identifies the Foundry branch. scenarioRid identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, branch must identify that non-default base branch.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the primary key value that is used as a unique identifier for an object.","plainTextDescription":"Represents the primary key value that is used as a unique identifier for an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}},"refresh":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"}}}},"updates":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Messages sent over the link type subscription WebSocket.","plainTextDescription":"Messages sent over the link type subscription WebSocket.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryOutputV2"},"type":{"type":"object","object":{"properties":{"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about the output of a query.","plainTextDescription":"Details about the output of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\n\nUse collectList or collectSet which will return a list of values in that case.\n","plainTextDescription":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\nUse collectList or collectSet which will return a list of values in that case.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A literal constraint value.","plainTextDescription":"A literal constraint value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A namespace for the type class.","plainTextDescription":"A namespace for the type class.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The value of the type class.","plainTextDescription":"The value of the type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Additional metadata that can be interpreted by user applications that interact with the Ontology\n","plainTextDescription":"Additional metadata that can be interpreted by user applications that interact with the Ontology","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.\n","plainTextDescription":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"},"type":{"type":"object","object":{"properties":{"signMediaReferences":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a `token` on each `MediaReference` value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\n\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.\n","plainTextDescription":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a token on each MediaReference value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Options for signing references in the response.","plainTextDescription":"Options for signing references in the response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field.","plainTextDescription":"Computes the approximate percentile value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deleteInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"}}}},"modifyInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"}}}},"createInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"},"type":{"type":"object","object":{"properties":{"regex":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The regular expression configured in the **Ontology Manager**.","plainTextDescription":"The regular expression configured in the Ontology Manager.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the **Ontology Manager**.\n","plainTextDescription":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must match a predefined regular expression.\n","plainTextDescription":"The parameter value must match a predefined regular expression.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given permission model.","plainTextDescription":"Returns action types with the given permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"},"type":{"type":"enum","enum":{"values":["START","END"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"entries":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","plainTextDescription":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a parameter ID argument in a logic rule.","plainTextDescription":"Represents a parameter ID argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"implementsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements.","plainTextDescription":"A list of interfaces that this object type implements.","example":[]}},"implementsInterfaces2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements and how it implements them.","plainTextDescription":"A list of interfaces that this object type implements and how it implements them.","example":[]}},"sharedPropertyTypeMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from shared property type API name to backing local property API name for the shared property types \npresent on this object type.\n","plainTextDescription":"A map from shared property type API name to backing local property API name for the shared property types\npresent on this object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"},"type":{"type":"object","object":{"properties":{"objectSetRidInputName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry restricted view.","plainTextDescription":"The RID of a Foundry restricted view.","example":["ri.foundry.main.restricted-view.8b2adf7c-ba8e-4d33-9bd7-46cc1c321ad4"]}},{"locator":{"namespaceName":"Ontologies","localName":"StringValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.\n","plainTextDescription":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsync","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RequestId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"Unique request id","plainTextDescription":"Unique request id","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenario"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"currentTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"}}}},"staticValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"}}}},"currentUser":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"}}}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"}}}},"interfaceParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"}}}},"synchronousWebhookOutput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"}}}},"objectParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"}}}},"uniqueIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.\n","plainTextDescription":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"},"type":{"type":"enum","enum":{"values":["STANDARD","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Currency rendering style options:\n- STANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\n- COMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")\n","plainTextDescription":"Currency rendering style options:\n\nSTANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\nCOMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value.","plainTextDescription":"Returns objects where the specified field is less than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Subtracts the right numeric value from the left numeric value.\n","plainTextDescription":"Subtracts the right numeric value from the left numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the `List interface types` endpoint and check the `allPropertiesV2` field or check\nthe **Ontology Manager**.\n","plainTextDescription":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the List interface types endpoint and check the allPropertiesV2 field or check\nthe Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QosError"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An error indicating that the subscribe request should be attempted on a different node.\n","plainTextDescription":"An error indicating that the subscribe request should be attempted on a different node.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"},"type":{"type":"object","object":{"properties":{"valueIfTrue":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is true","plainTextDescription":"Value to display if this boolean is true","example":[]}},"valueIfFalse":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is false","plainTextDescription":"Value to display if this boolean is false","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for boolean property values.","plainTextDescription":"Formatting configuration for boolean property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the object type with the given rid as an input or product.\n","plainTextDescription":"Returns action types which reference the object type with the given rid as an input or product.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.\n","plainTextDescription":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String or a double number.","plainTextDescription":"An object which is either an enum String or a double number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timestampFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"}}}},"operationIdsFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"description":"Map of the name of the derived property to return and its definition\n","plainTextDescription":"Map of the name of the derived property to return and its definition","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet which returns objects with additional derived properties.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which returns objects with additional derived properties.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"envelope":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}}},"geoJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.\n","plainTextDescription":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the object type.","plainTextDescription":"The API name of the object type.","example":["exampleAircraft"]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Ontology"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.\n","plainTextDescription":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series codex template that resolves to a derived series.","plainTextDescription":"The RID identifying a time series codex template that resolves to a derived series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns a single value of an array as configured in the ontology.","plainTextDescription":"Returns a single value of an array as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Calculates absolute value of a numeric value.\n","plainTextDescription":"Calculates absolute value of a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the object type with the given rid.","plainTextDescription":"Returns action types which edit the object type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides the left numeric value by the right numeric value.\n","plainTextDescription":"Divides the left numeric value by the right numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter expects an array of values and the size of the array must fall within the defined range.\n","plainTextDescription":"The parameter expects an array of values and the size of the array must fall within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"},"type":{"type":"object","object":{"properties":{"values":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".\n","plainTextDescription":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"},"type":{"type":"enum","enum":{"values":["ACTIVE","DEPRECATED"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given rid.","plainTextDescription":"Returns action types with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"TBD","plainTextDescription":"TBD","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"},"type":{"type":"enum","enum":{"values":["CEIL","FLOOR","ROUND_CLOSEST"]}},"safety":"SAFE","documentation":{"description":"Number rounding behavior:\n- CEIL: Always round up (3.1 becomes 4)\n- FLOOR: Always round down (3.9 becomes 3)\n- ROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)\n","plainTextDescription":"Number rounding behavior:\n\nCEIL: Always round up (3.1 becomes 4)\nFLOOR: Always round down (3.9 becomes 3)\nROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"alignmentTimestamp":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\n\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\n\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM, \neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.\n","plainTextDescription":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM,\neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.","example":[]}},"windowType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Aggregates values over discrete, periodic windows for a given time series.\n\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\n\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.\n","plainTextDescription":"Aggregates values over discrete, periodic windows for a given time series.\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.\n","plainTextDescription":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter must be omitted or empty.","plainTextDescription":"The parameter must be omitted or empty.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The response when loading entries from a geotemporal series reference property.\n\nEach entry in `data` is a map of property names to values containing the fields requested via\n`additionalProperties` in the corresponding `LoadGeotemporalSeriesRequest`. If `nextPageToken` is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.\n","plainTextDescription":"The response when loading entries from a geotemporal series reference property.\nEach entry in data is a map of property names to values containing the fields requested via\nadditionalProperties in the corresponding LoadGeotemporalSeriesRequest. If nextPageToken is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names that have been modified within the scenario.","plainTextDescription":"The list of link type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The link types that have been modified within a scenario.\n","plainTextDescription":"The link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditTypeFilter"},"type":{"type":"enum","enum":{"values":["create","modify","delete"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is in development.","plainTextDescription":"This status indicates that the PropertyType is in development.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"},"type":{"type":"enum","enum":{"values":["RUNNING_SUBMISSION_CHECKS","EXECUTING_WRITE_BACK_WEBHOOK","COMPUTING_ONTOLOGY_EDITS","COMPUTING_FUNCTION","WRITING_ONTOLOGY_EDITS","EXECUTING_SIDE_EFFECT_WEBHOOK","SENDING_NOTIFICATIONS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to \nspecify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, \nbut not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to\nspecify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,\nbut not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryRequest"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"filters":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sortOrder":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeAllPreviousProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of edits to return per page. Defaults to 100.","plainTextDescription":"The maximum number of edits to return per page. Defaults to 100.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request object for querying object type edits history, containing both filters and pagination parameters\n\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.\n","plainTextDescription":"Request object for querying object type edits history, containing both filters and pagination parameters\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"cause":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The subscription has been closed due to an irrecoverable error during its lifecycle.\n","plainTextDescription":"The subscription has been closed due to an irrecoverable error during its lifecycle.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface link type.","plainTextDescription":"The description of the interface link type.","example":[]}},"linkedEntityApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare at least one implementation of this link.\n","plainTextDescription":"Whether each implementing object type must declare at least one implementation of this link.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.\n","plainTextDescription":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface property type.","plainTextDescription":"The description of the interface property type.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypeRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface parameter property argument in a logic rule.","plainTextDescription":"Represents an interface parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinksResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of linked objects that have been edited within the scenario, grouped by source object.\n","plainTextDescription":"The list of linked objects that have been edited within the scenario, grouped by source object.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.\n","plainTextDescription":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the `List interface types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the List interface types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"now":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"}}}},"fixed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A datetime bound value.","plainTextDescription":"A datetime bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The ID identifying a transaction.","plainTextDescription":"The ID identifying a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via `PropertyWithLoadLevelSelector`) to opt a property out of a\n`defaultLoadLevel`.\n","plainTextDescription":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via PropertyWithLoadLevelSelector) to opt a property out of a\ndefaultLoadLevel.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.\n","plainTextDescription":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"auto":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"}}}},"off":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Fuzziness setting applied to `contains` full-text string predicates in the search query. If not provided,\n`auto` is used.\n","plainTextDescription":"Fuzziness setting applied to contains full-text string predicates in the search query. If not provided,\nauto is used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.\n","plainTextDescription":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.\n","plainTextDescription":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"},"type":{"type":"enum","enum":{"values":["newest_first","oldest_first"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"queryTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaMetadata"},"type":{"type":"object","object":{"properties":{"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Adds two or more numeric values.\n","plainTextDescription":"Adds two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}},"safety":"UNSAFE","documentation":{"example":[]}},"additionalProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.\n","plainTextDescription":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request body for loading entries from a geotemporal series reference property.\n\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as `OntologyObjectV2`.\n\nThe `range` field is required and restricts results to a specific time window. Both `startTime` and `endTime`\nare required on `range`. The `additionalProperties` field controls which additional properties appear in each\nreturned entry. Results are paginated; use `pageToken` from a previous response to retrieve additional pages.\n","plainTextDescription":"The request body for loading entries from a geotemporal series reference property.\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as OntologyObjectV2.\nThe range field is required and restricts results to a specific time window. Both startTime and endTime\nare required on range. The additionalProperties field controls which additional properties appear in each\nreturned entry. Results are paginated; use pageToken from a previous response to retrieve additional pages.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransaction"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Integer key for fixed value mapping.","plainTextDescription":"Integer key for fixed value mapping.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Query"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"By default, whenever an object is requested, all of its properties are returned, except for properties of the \nfollowing types:\n- Vector\n\nThe response can be filtered to only include certain properties using the `properties` query parameter. Note\nthat ontology object set endpoints refer to this parameter as `select`.\n\nProperties to include can be specified in one of two ways.\n\n- A comma delimited list as the value for the `properties` query parameter\n `properties={property1ApiName},{property2ApiName}`\n- Multiple `properties` query parameters.\n `properties={property1ApiName}&properties={property2ApiName}`\n\nThe primary key of the object will always be returned even if it wasn't specified in the `properties` values.\n\nUnknown properties specified in the `properties` list will result in a `PropertiesNotFound` error.\n\nTo find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"By default, whenever an object is requested, all of its properties are returned, except for properties of the\nfollowing types:\n\nVector\n\nThe response can be filtered to only include certain properties using the properties query parameter. Note\nthat ontology object set endpoints refer to this parameter as select.\nProperties to include can be specified in one of two ways.\n\nA comma delimited list as the value for the properties query parameter\nproperties={property1ApiName},{property2ApiName}\nMultiple properties query parameters.\nproperties={property1ApiName}&properties={property2ApiName}\n\nThe primary key of the object will always be returned even if it wasn't specified in the properties values.\nUnknown properties specified in the properties list will result in a PropertiesNotFound error.\nTo find the API name for your property, use the Get object type endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid RID (Resource Identifier).","plainTextDescription":"The string must be a valid RID (Resource Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"},"type":{"type":"object","object":{"properties":{"topLeft":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bottomRight":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The top left and bottom right coordinate points that make up the bounding box.\n","plainTextDescription":"The top left and bottom right coordinate points that make up the bounding box.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"},"type":{"type":"object","object":{"properties":{"operationIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"},"type":{"type":"object","object":{"properties":{"webhookOutputParamName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the webhook output parameter.","plainTextDescription":"The name of the webhook output parameter.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a synchronous webhook output argument in a logic rule.","plainTextDescription":"Represents a synchronous webhook output argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of \ntext fields. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of\ntext fields. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where every query is satisfied. An empty list matches all action types.","plainTextDescription":"Returns action types where every query is satisfied. An empty list matches all action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationObjectTypeGrouping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across \nmultiple object types, such as when aggregating over an interface type.\n","plainTextDescription":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across\nmultiple object types, such as when aggregating over an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"},"type":{"type":"enum","enum":{"values":["ASC","DESC"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"},"type":{"type":"object","object":{"properties":{"disjunction":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A disjunctive set of security results for a property value.\n","plainTextDescription":"A disjunctive set of security results for a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute datetime bound (ISO 8601 timestamp or date string).","plainTextDescription":"An absolute datetime bound (ISO 8601 timestamp or date string).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Indicates that the link types cannot be incrementally updated and must be refreshed.\n","plainTextDescription":"Indicates that the link types cannot be incrementally updated and must be refreshed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.\n","plainTextDescription":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"},"type":{"type":"enum","enum":{"values":["DAY","WEEK","MONTH","YEAR"]}},"safety":"SAFE","documentation":{"description":"Units for relative time calculations.","plainTextDescription":"Units for relative time calculations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"versionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must conform to the referenced value type.","plainTextDescription":"The parameter value must conform to the referenced value type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String, double number, or a geopoint.","plainTextDescription":"An object which is either an enum String, double number, or a geopoint.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.","plainTextDescription":"Divides objects into groups according to an exact value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"add":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"}}}},"absoluteValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"}}}},"extract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"}}}},"selection":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"}}}},"negate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"least":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"}}}},"divide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"}}}},"multiply":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"}}}},"greatest":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Definition of a derived property.\n","plainTextDescription":"Definition of a derived property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Duration"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"},"type":{"type":"object","object":{"properties":{"editedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Multiplies two or more numeric values.\n","plainTextDescription":"Multiplies two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"},"type":{"type":"object","object":{"properties":{"wrappedType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique id of a geotime series (track) associated with a GTSR.","plainTextDescription":"The unique id of a geotime series (track) associated with a GTSR.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `kind` attribute of a type class.","plainTextDescription":"Exact match predicate for the kind attribute of a type class.","example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `name` attribute of a type class.","plainTextDescription":"Exact match predicate for the name attribute of a type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching type classes. Matches a type class when `kind`, and `name` if provided, match the\ncorresponding attribute of the type class. If `name` is empty, only `kind` is required to match. You can\nsearch for both parameter type classes and action type type classes.\n","plainTextDescription":"A predicate for matching type classes. Matches a type class when kind, and name if provided, match the\ncorresponding attribute of the type class. If name is empty, only kind is required to match. You can\nsearch for both parameter type classes and action type type classes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names scoped by the object type.","plainTextDescription":"The list of link type API names scoped by the object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.\n","plainTextDescription":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Attachment"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation ranges.\n","plainTextDescription":"A union of all the types supported by query aggregation ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","plainTextDescription":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"The magnitude of a relative datetime offset.","plainTextDescription":"The magnitude of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsMultipleObjectTypes` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an ontology scenario.","plainTextDescription":"The unique resource identifier of an ontology scenario.","example":["ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"},"type":{"type":"object","object":{"properties":{"tableRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TableRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry table.","plainTextDescription":"An object type datasource backed by a Foundry table.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsRequest"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for staging edits to a transaction.","plainTextDescription":"The request payload for staging edits to a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Duration"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 formatted duration.","plainTextDescription":"An ISO 8601 formatted duration.","example":["PT15M"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"},"type":{"type":"object","object":{"properties":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"}}}},"datetime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"}}}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"}}}},"markdown":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"}}}},"mustBeEmpty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The allowed-values constraint configured on an action parameter.","plainTextDescription":"The allowed-values constraint configured on an action parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"},"type":{"type":"object","object":{"properties":{"implementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via applying reducers on the nested implementation.","plainTextDescription":"An implementation of an interface property via applying reducers on the nested implementation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"An override value to be used for a UniqueIdentifier action parameter, instead of \nthe value being automatically generated.\n","plainTextDescription":"An override value to be used for a UniqueIdentifier action parameter, instead of\nthe value being automatically generated.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"}}},"safety":"SAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided, \nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Reason"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.","plainTextDescription":"Divides objects into groups with the specified width.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioConflictingObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have a conflicting edit within the scenario.","plainTextDescription":"The list of objects that have a conflicting edit within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have a conflicting edit within a scenario for a given object type.","plainTextDescription":"The objects that have a conflicting edit within a scenario for a given object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Affix"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"\n","plainTextDescription":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"webhookRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"}}}},"hasActionLog":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"}}}},"actionTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"}}}},"permissionModel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"}}}},"hasWebhook":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"}}}},"actionTypeDisplayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"}}}},"affectedLinkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"}}}},"actionTypeDescription":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"}}}},"sectionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"}}}},"parameterRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"}}}},"parameterName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"}}}},"hasNotification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"}}}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"}}}},"inputObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"}}}},"revertActionEnabled":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"}}}},"logicRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"}}}},"typeClasses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"}}}},"affectedInterfaceTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"}}}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"}}}},"affectedObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"}}}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the search query for an action type search. Supports filters for various action type features.\n","plainTextDescription":"Represents the search query for an action type search. Supports filters for various action type features.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the average value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"},"type":{"type":"enum","enum":{"values":["BEFORE","AFTER"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a struct parameter's fields against the configured constraints.","plainTextDescription":"Represents the validity of a struct parameter's fields against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.","plainTextDescription":"Divides objects into groups according to specified ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"},"type":{"type":"object","object":{"properties":{"unionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.\n","plainTextDescription":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"interfaceDefinedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"}}}},"interfaceSharedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.\n","plainTextDescription":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"toolDescription":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Optional description intended for tool use contexts, such as AI agents.","plainTextDescription":"Optional description intended for tool use contexts, such as AI agents.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end date.","plainTextDescription":"Exclusive end date.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive end date.","plainTextDescription":"Inclusive end date.","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive start date.","plainTextDescription":"Exclusive start date.","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start date.","plainTextDescription":"Inclusive start date.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a date range from an inclusive start date to an exclusive end date.","plainTextDescription":"Specifies a date range from an inclusive start date to an exclusive end date.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"pluralDisplayName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The plural display name of the object type.","plainTextDescription":"The plural display name of the object type.","example":[]}},"icon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Icon"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"aliases":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. `getObjectTypeV2`); it is always empty on the `listObjectTypesV2` endpoint.\n","plainTextDescription":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. getObjectTypeV2); it is always empty on the listObjectTypesV2 endpoint.","example":[]}},"datasources":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"}}}}},"safety":"UNSAFE","documentation":{"description":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies `includeDatasources=true`. This list may be empty if the user doesn't have access to any\ndatasources.\n","plainTextDescription":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies includeDatasources=true. This list may be empty if the user doesn't have access to any\ndatasources.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"description":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\n\nEach object type's `linkTypes` is only populated when the request specifies\n`includeLinkTypes=true`, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.\n","plainTextDescription":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\nEach object type's linkTypes is only populated when the request specifies\nincludeLinkTypes=true, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectSetChanged":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"}}}},"refreshObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"}}}},"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"},"type":{"type":"object","object":{"properties":{"includesAllPreviousValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.\n","plainTextDescription":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"geometry":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"}}},"safety":"UNSAFE","documentation":{"example":[]}},"spatialFilterMode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager**\napplication.\n","plainTextDescription":"The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager\napplication.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given status.","plainTextDescription":"Returns action types with the given status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an attachment.","plainTextDescription":"The unique resource identifier of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"},"type":{"type":"object","object":{"properties":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the `fields` array is provided, `orderType` is automatically set to `fields`.\nIf this object is omitted entirely, the ordering is unspecified.\n\nSetting `orderType` to `relevance` requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. `containsAllTerms`, `containsAnyTerm`,\n`containsAllTermsInOrder`, `containsAllTermsInOrderPrefixLastTerm`) or `nearestNeighbors`, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\n\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\n\nRelevance ordering can be expensive and should only be used when required.\n","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the fields array is provided, orderType is automatically set to fields.\nIf this object is omitted entirely, the ordering is unspecified.\nSetting orderType to relevance requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. containsAllTerms, containsAnyTerm,\ncontainsAllTermsInOrder, containsAllTermsInOrderPrefixLastTerm) or nearestNeighbors, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\nRelevance ordering can be expensive and should only be used when required.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"},"type":{"type":"object","object":{"properties":{"showFullUnits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to show full or abbreviated time units.","plainTextDescription":"Whether to show full or abbreviated time units.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formats the duration as a human-readable written string.","plainTextDescription":"Formats the duration as a human-readable written string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"},"type":{"type":"object","object":{"properties":{"zoneId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"},"type":{"type":"enum","enum":{"values":["fields","relevance"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"}}}},"get":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"}}}},"collectList":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"}}}},"collectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property\n","plainTextDescription":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"},"type":{"type":"object","object":{"properties":{"defaultValidation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation metadata surfaced for a parameter.","plainTextDescription":"Validation metadata surfaced for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from the backing column struct field names to a struct property's fields.\n","plainTextDescription":"A mapping from the backing column struct field names to a struct property's fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the maximum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for date property values.","plainTextDescription":"Formatting configuration for date property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a display name matching the given string predicate.","plainTextDescription":"Returns action types with a display name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"},"type":{"type":"enum","enum":{"values":["SUM","MEAN","STANDARD_DEVIATION","MAX","MIN","PERCENT_CHANGE","DIFFERENCE","PRODUCT","COUNT","FIRST","LAST"]}},"safety":"SAFE","documentation":{"description":"The aggregation function to use for aggregating time series data.\n","plainTextDescription":"The aggregation function to use for aggregating time series data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to specified ranges.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyObjectTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","plainTextDescription":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Property"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"},"type":{"type":"object","object":{"properties":{"term":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The term to match.","plainTextDescription":"The term to match.","example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.\n","plainTextDescription":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.\n","plainTextDescription":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioResponse"},"type":{"type":"object","object":{"properties":{"scenarioRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The response payload for creating an ontology scenario.","plainTextDescription":"The response payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}}},"pointsCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\n\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.\n","plainTextDescription":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"},"type":{"type":"object","object":{"properties":{"typeId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to a type that is defined in the `typeReferences` map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.\n","plainTextDescription":"A reference to a type that is defined in the typeReferences map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"},"type":{"type":"object","object":{"properties":{"uniqueIdentifierLinkIdValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"}}}}},"safety":"SAFE","documentation":{"example":[]}},"actionExecutionTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"},"type":{"type":"object","object":{"properties":{"scaleType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n- THOUSANDS: 1500 displays as \"1.5K\"\n- MILLIONS: 2500000 displays as \"2.5M\"\n- BILLIONS: 3200000000 displays as \"3.2B\"\n","plainTextDescription":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n\nTHOUSANDS: 1500 displays as \"1.5K\"\nMILLIONS: 2500000 displays as \"2.5M\"\nBILLIONS: 3200000000 displays as \"3.2B\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings representing the same sequence of characters as the given string.","plainTextDescription":"Matches strings representing the same sequence of characters as the given string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"},"type":{"type":"enum","enum":{"values":["actionTypeDisplayName"]}},"safety":"SAFE","documentation":{"description":"Specifies the field to sort action types by.","plainTextDescription":"Specifies the field to sort action types by.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"},"type":{"type":"object","object":{"properties":{"maxSizeBytes":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","plainTextDescription":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property filter. For instance, false is the FilterValue in\n`properties.{propertyApiName}.isNull=false`.\n","plainTextDescription":"Represents the value of a property filter. For instance, false is the FilterValue in\nproperties.{propertyApiName}.isNull=false.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"request":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkState"},"type":{"type":"enum","enum":{"values":["ADDED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.\n","plainTextDescription":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsOrInterfaces` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingInterfaceLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface link types in the current page.","plainTextDescription":"The list of interface link types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"},"type":{"type":"enum","enum":{"values":["INTERSECTS","DISJOINT","WITHIN","CONTAINS"]}},"safety":"SAFE","documentation":{"description":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.\n","plainTextDescription":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"},"type":{"type":"object","object":{"properties":{"geoJson":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.\n","plainTextDescription":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry specification.","plainTextDescription":"A GeoJSON geometry specification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version of the given Function, written `..-`, where `-` is optional.\nExamples: `1.2.3`, `1.2.3-rc1`.\n","plainTextDescription":"The version of the given Function, written ..-, where - is optional.\nExamples: 1.2.3, 1.2.3-rc1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.\n","plainTextDescription":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a parameter matching the given parameter rid.","plainTextDescription":"Returns action types with a parameter matching the given parameter rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"relativePoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a bound for a relative date range query.","plainTextDescription":"Specifies a bound for a relative date range query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the primary key property of an object type which is present on all object types.","plainTextDescription":"Specifies the primary key property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"}}}},"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked entity. This can either be an object or an interface type.","plainTextDescription":"A reference to the linked entity. This can either be an object or an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Definition for a selected property over a MethodObjectSet.","plainTextDescription":"Definition for a selected property over a MethodObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the **Ontology Manager**.\n","plainTextDescription":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of directed link type API names.","plainTextDescription":"A list of directed link type API names.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface.","plainTextDescription":"The description of the interface.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"allProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has, including properties from all directly and indirectly extended \ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has, including properties from all directly and indirectly extended\ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.","example":[]}},"allPropertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.","example":[]}},"extendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n","plainTextDescription":"A list of interface API names that this interface extends. An interface can extend other interfaces to\ninherit their properties.","example":[]}},"allExtendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends, both directly and indirectly.\n","plainTextDescription":"A list of interface API names that this interface extends, both directly and indirectly.","example":[]}},"implementedByObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object API names that implement this interface.\n","plainTextDescription":"A list of object API names that implement this interface.","example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.","example":[]}},"allLinks":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface type in the Ontology.","plainTextDescription":"Represents an interface type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier for an action.","plainTextDescription":"The unique resource identifier for an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"},"type":{"type":"enum","enum":{"values":["ADD_OBJECT","MODIFY_OBJECT","DELETE_OBJECT","ADD_LINK","DELETE_LINK","FUNCTION","BATCHED_FUNCTION","ADD_OR_MODIFY_OBJECT","ADD_OR_MODIFY_OBJECT_V2"]}},"safety":"SAFE","documentation":{"description":"Filter action types by the type of logic rule they contain.","plainTextDescription":"Filter action types by the type of logic rule they contain.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterface"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"deadline":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"example":[]}},"replacedBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.\n","plainTextDescription":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a link type. To find the ID for your link type, check the **Ontology Manager** application.\n","plainTextDescription":"The unique ID of a link type. To find the ID for your link type, check the Ontology Manager application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the \n[Ontology Manager](/docs/foundry/ontology-manager/overview/).\n","plainTextDescription":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the\nOntology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"},"type":{"type":"object","object":{"properties":{"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating one of the **submission criteria** was not satisfied.\nThis is configured per **submission criteria** in the **Ontology Manager**.\n","plainTextDescription":"The message indicating one of the submission criteria was not satisfied.\nThis is configured per submission criteria in the Ontology Manager.","example":[]}},"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Contains the status of the **submission criteria**.\n**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the **Ontology Manager**.\n","plainTextDescription":"Contains the status of the submission criteria.\nSubmission criteria are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherTextProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"part":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts the specified date part from a date or timestamp.\n","plainTextDescription":"Extracts the specified date part from a date or timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"dateValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DateValue"}}}},"stringValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringValue"}}}},"timestampValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"}}}},"booleanValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"}}}},"integerValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"}}}},"doubleValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"}}}},"longValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LongValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property api name that references properties to query on.","plainTextDescription":"A property api name that references properties to query on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have an action log.","plainTextDescription":"Returns action types based on whether they have an action log.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"geopoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoPointType"}}}},"geotimeSeriesReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeotimeSeriesReferenceType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"timeseries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimeseriesType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Object properties.\n","plainTextDescription":"A union of all the types supported by Ontology Object properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Formats the duration in a timecode format.","plainTextDescription":"Formats the duration in a timecode format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operationId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The user ID or principal that performed the action","plainTextDescription":"The user ID or principal that performed the action","example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"When this edit occurred (ISO 8601 format)","plainTextDescription":"When this edit occurred (ISO 8601 format)","example":[]}},"edit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.\n","plainTextDescription":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action.","plainTextDescription":"Details about a parameter of an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesFullMetadataResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamingOutputFormat"},"type":{"type":"enum","enum":{"values":["JSON","ARROW"]}},"safety":"SAFE","documentation":{"description":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.\n","plainTextDescription":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsForInterfaceResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface instances in the current page.","plainTextDescription":"The list of interface instances in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The source of a constraint bound value.","plainTextDescription":"The source of a constraint bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"optional":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API.\n","plainTextDescription":"The name of the Query in the API.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"},"type":{"type":"object","object":{"properties":{"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"KnownType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formatting configuration for known Foundry types.","plainTextDescription":"Formatting configuration for known Foundry types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueType"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. |\n| Attachment | `Attachment` |\n| Boolean | `Boolean` |\n| Byte | `Byte` |\n| CipherText | `CipherText` |\n| Date | `LocalDate` |\n| Decimal | `Decimal` |\n| Double | `Double` |\n| Float | `Float` |\n| Integer | `Integer` |\n| Long | `Long` |\n| Marking | `Marking` |\n| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. |\n| Short | `Short` |\n| String | `String` |\n| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` |\n| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. |\n| Timestamp | `Timestamp` |\n","plainTextDescription":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | Array, where T is the type of the array elements, e.g. Array. |\n| Attachment | Attachment |\n| Boolean | Boolean |\n| Byte | Byte |\n| CipherText | CipherText |\n| Date | LocalDate |\n| Decimal | Decimal |\n| Double | Double |\n| Float | Float |\n| Integer | Integer |\n| Long | Long |\n| Marking | Marking |\n| OntologyObject | OntologyObject where T is the API name of the referenced object type. |\n| Short | Short |\n| String | String |\n| Struct | Struct where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> |\n| Timeseries | TimeSeries where T is either String for an enum series or Double for a numeric series. |\n| Timestamp | Timestamp |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked interface type.","plainTextDescription":"A reference to the linked interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Error"},"type":{"type":"object","object":{"properties":{"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"}}},"safety":"SAFE","documentation":{"example":[]}},"args":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Arg"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry stream.","plainTextDescription":"The RID of a Foundry stream.","example":["ri.foundry.main.stream.f7e91c94-1cb2-4e34-8fdb-3da7c1a91e8b"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.\n","plainTextDescription":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"rid","rid":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current user argument in a logic rule.","plainTextDescription":"Represents the current user argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CustomTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A UUID representing a custom type in a given Function.\n","plainTextDescription":"A UUID representing a custom type in a given Function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a description matching the given string predicate.","plainTextDescription":"Returns action types with a description matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedEntityTypesResponse"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of edited link types grouped by source object type.\n\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.\n","plainTextDescription":"The list of edited link types grouped by source object type.\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types and link types that have been modified within a scenario.\n","plainTextDescription":"The object types and link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedTimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"templateRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"}}},"safety":"SAFE","documentation":{"example":[]}},"templateVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by a derived time series calculated with a formula.","plainTextDescription":"The representation of a time series property backed by a derived time series calculated with a formula.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"constraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS","QUARTERS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.\n","plainTextDescription":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a property.","plainTextDescription":"The unique resource identifier of a property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"partialMatch":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a classification or mandatory marking.","plainTextDescription":"The id of a classification or mandatory marking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which use the function with the given rid.","plainTextDescription":"Returns action types which use the function with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequest"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"query":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationV2"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsyncV2","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field.","plainTextDescription":"Returns objects based on the existence of the specified field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"}}}},"number":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"}}}},"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces. \nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\n\nEach formatter type provides specific options tailored to that data type:\n- Numbers: Support for percentages, currencies, units, scaling, and custom formatting\n- Dates/Timestamps: Localized and custom formatting patterns\n- Booleans: Custom true/false display text\n- Known types: Special formatting for Foundry-specific identifiers\n","plainTextDescription":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces.\nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\nEach formatter type provides specific options tailored to that data type:\n\nNumbers: Support for percentages, currencies, units, scaling, and custom formatting\nDates/Timestamps: Localized and custom formatting patterns\nBooleans: Custom true/false display text\nKnown types: Special formatting for Foundry-specific identifiers","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"},"type":{"type":"enum","enum":{"values":["DATASOURCE_DERIVED_PERMISSIONS","ONTOLOGY_ROLES","COMPASS_PROJECT"]}},"safety":"SAFE","documentation":{"description":"Filter action types by permission model.","plainTextDescription":"Filter action types by permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaReferenceProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched terms must occur in order.","plainTextDescription":"If true, the matched terms must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing the terms in the query\n","plainTextDescription":"Matches intervals containing the terms in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter.","plainTextDescription":"A possible value for the parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DateValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"date","date":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in string format. This is used in URL parameters.","plainTextDescription":"Represents the value of a property in string format. This is used in URL parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"},"type":{"type":"enum","enum":{"values":["USER_CLOSED","CHANNEL_CLOSED"]}},"safety":"SAFE","documentation":{"description":"Represents the reason a subscription was closed.\n","plainTextDescription":"Represents the reason a subscription was closed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the server was not able to load the securities of the property.","plainTextDescription":"Indicates the server was not able to load the securities of the property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current Page.","plainTextDescription":"The list of objects in the current Page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`.","plainTextDescription":"Represents the API response when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"constant":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"}}}},"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentProperty"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The representation of an attachment as a data type.","plainTextDescription":"The representation of an attachment as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager**\napplication and assign them API names. In every other case, API names should be used instead of property IDs.\n","plainTextDescription":"The immutable ID of a property. Property IDs are only used to identify properties in the Ontology Manager\napplication and assign them API names. In every other case, API names should be used instead of property IDs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The base used to initialize a scenario.","plainTextDescription":"The base used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"any":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AnyType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the primitive types used by Palantir's Ontology-based products.\n","plainTextDescription":"A union of all the primitive types used by Palantir's Ontology-based products.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"}}}}},"safety":"UNSAFE","documentation":{"description":"List of historical edits for this object type","plainTextDescription":"List of historical edits for this object type","example":[]}},"totalCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Count of items in the data array above","plainTextDescription":"Count of items in the data array above","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.\n","plainTextDescription":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"},"type":{"type":"object","object":{"properties":{"color":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A hexadecimal color code.","plainTextDescription":"A hexadecimal color code.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. \nUsed to specify the Blueprint icon to represent the object type in a React app.\n","plainTextDescription":"The name of the Blueprint icon.\nUsed to specify the Blueprint icon to represent the object type in a React app.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"reducers":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"}}}}},"safety":"UNSAFE","documentation":{"description":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.\n","plainTextDescription":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the struct type to the value type applied to that property.","plainTextDescription":"A map of the properties of the struct type to the value type applied to that property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A valid format string composed of date/time patterns.","plainTextDescription":"A valid format string composed of date/time patterns.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A strictly specified date format pattern.","plainTextDescription":"A strictly specified date format pattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"transactionId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"absolute":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute or relative range for a time series query.","plainTextDescription":"An absolute or relative range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"},"type":{"type":"object","object":{"properties":{"mapping":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be a property value of an object found within an object set.\n","plainTextDescription":"The parameter value must be a property value of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LongValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.\n","plainTextDescription":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"},"type":{"type":"object","object":{"properties":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A branch reference used to initialize a scenario.","plainTextDescription":"A branch reference used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"description":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.\n","plainTextDescription":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["fo*o"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the wildcard pattern provided.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the wildcard pattern provided.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Action"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"standard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"}}}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"}}}},"fixedValues":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"}}}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"}}}},"scale":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"}}}},"currency":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"}}}},"standardUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"}}}},"customUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"}}}},"ratio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToDelete":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}},"includeLinkTypes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all outgoing link types for each requested object type in that object type's\n`linkTypes`. When false or omitted, `linkTypes` is empty.\n","plainTextDescription":"A flag that will return all outgoing link types for each requested object type in that object type's\nlinkTypes. When false or omitted, linkTypes is empty.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"},"type":{"type":"object","object":{"properties":{"interfaceType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object set with objects that implement the interface with the given interface API name. The objects in \nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.\n","plainTextDescription":"An object set with objects that implement the interface with the given interface API name. The objects in\nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.","example":[]}},"includeAllBaseObjectProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all of the underlying object properties for the objects that implement the interface. \nThis includes properties that don't explicitly implement an SPT on the interface.\n","plainTextDescription":"A flag that will return all of the underlying object properties for the objects that implement the interface.\nThis includes properties that don't explicitly implement an SPT on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"},"type":{"type":"object","object":{"properties":{"direction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"}}},"safety":"SAFE","documentation":{"example":[]}},"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"},"type":{"type":"enum","enum":{"values":["ADDED_OR_UPDATED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was \nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object \nwas removed from the set due to the object being deleted or the object no longer meets the object set \ndefinition.\n","plainTextDescription":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was\nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object\nwas removed from the set due to the object being deleted or the object no longer meets the object set\ndefinition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a geotime integration.","plainTextDescription":"The unique resource identifier of a geotime integration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SecuredPropertyValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertySecurityIndex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.\n","plainTextDescription":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationOrderBy"},"type":{"type":"object","object":{"properties":{"metricName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds greatest of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds greatest of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.\n","plainTextDescription":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"geotimeSeriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a geotime series integration as a data type.","plainTextDescription":"The representation of a geotime series integration as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name or RID of the Ontology. To find the API name or RID, use the **List Ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or\ncheck the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"},"type":{"type":"enum","enum":{"values":["REQUIRE_ACCURATE","ALLOW_APPROXIMATE"]}},"safety":"SAFE","documentation":{"description":"Specifies the accuracy requirement for aggregation results.\n\n- `REQUIRE_ACCURATE`: Only return results if they are guaranteed to be accurate. If accuracy cannot be\n guaranteed (e.g., due to a low `maxGroupCount` relative to distinct values), the request will fail\n with an `AggregationAccuracyNotSupported` error.\n- `ALLOW_APPROXIMATE`: Allow approximate results when exact computation is not feasible. This is the\n default behavior if not specified.\n","plainTextDescription":"Specifies the accuracy requirement for aggregation results.\n\nREQUIRE_ACCURATE: Only return results if they are guaranteed to be accurate. If accuracy cannot be\nguaranteed (e.g., due to a low maxGroupCount relative to distinct values), the request will fail\nwith an AggregationAccuracyNotSupported error.\nALLOW_APPROXIMATE: Allow approximate results when exact computation is not feasible. This is the\ndefault behavior if not specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value.","plainTextDescription":"Returns objects where the specified field is less than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"},"type":{"type":"object","object":{"properties":{"ciphertext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CipherText"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.","example":[{"ciphertext":"CIPHER::ri.bellaso.main.cipher-channel.x::::CIPHER"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the `typeReferences` map of the enclosing Query.\n","plainTextDescription":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the typeReferences map of the enclosing Query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"},"type":{"type":"object","object":{"properties":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the media view.\n","plainTextDescription":"The set of properties that are bound to the media view.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.\n","plainTextDescription":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"},"type":{"type":"object","object":{"properties":{"sourceObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsForInterfaceRequest"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"augmentedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from object type API name to a list of property type API names. For each returned object, if the \nobject’s object type is a key in the map, then we augment the response for that object type with the list \nof properties specified in the value.\n","plainTextDescription":"A map from object type API name to a list of property type API names. For each returned object, if the\nobject’s object type is a key in the map, then we augment the response for that object type with the list\nof properties specified in the value.","example":[]}},"augmentedSharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"augmentedInterfacePropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of interface property type API names. For each returned object, \nif the object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of interface property type API names. For each returned object,\nif the object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"selectedSharedPropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of shared property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of shared property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedInterfacePropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of interface property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the \nparameter to include all object types.\n","plainTextDescription":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the\nparameter to include all object types.","example":[]}},"otherInterfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be \nincluded in the response.\n","plainTextDescription":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be\nincluded in the response.","example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"},"type":{"type":"enum","enum":{"values":["VALID","INVALID"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a validation.\n","plainTextDescription":"Represents the state of a validation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"},"type":{"type":"object","object":{"properties":{"targetObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe `targetObject` Ontology Object in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe targetObject Ontology Object in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"KnownType"},"type":{"type":"enum","enum":{"values":["USER_OR_GROUP_ID","RESOURCE_RID","ARTIFACT_GID"]}},"safety":"SAFE","documentation":{"description":"Known Foundry types for specialized formatting:\n- userOrGroupRid: Format as user or group\n- resourceRid: Format as resource \n- artifactGid: Format as artifact\n","plainTextDescription":"Known Foundry types for specialized formatting:\n\nuserOrGroupRid: Format as user or group\nresourceRid: Format as resource\nartifactGid: Format as artifact","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they reference a webhook.","plainTextDescription":"Returns action types based on whether they reference a webhook.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"},"type":{"type":"object","object":{"properties":{"method":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"}}},"safety":"SAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct parameter field argument in a logic rule.","plainTextDescription":"Represents a struct parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"},"type":{"type":"object","object":{"properties":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionInputValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"}}}}},"safety":"UNSAFE","documentation":{"description":"The predefined set of options.","plainTextDescription":"The predefined set of options.","example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether values outside `options` are allowed.","plainTextDescription":"Whether values outside options are allowed.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be one of a fixed set of labelled options.","plainTextDescription":"The parameter value must be one of a fixed set of labelled options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo"]}}}}},"safety":"UNSAFE","documentation":{"description":"Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`, which is preferred because the name `startsWith` is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via a local property.","plainTextDescription":"An implementation of an interface property via a local property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"link":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of groups to return. If omitted, defaults to 10,000.\n\nThe server allocates resources based on the specified `maxGroupCount`. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\n\nIf you need accurate results with high-cardinality properties, set `maxGroupCount` high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\n`excludedItems`. The response `accuracy` field indicates whether the results are `ACCURATE` or\n`APPROXIMATE`.\n","plainTextDescription":"The maximum number of groups to return. If omitted, defaults to 10,000.\nThe server allocates resources based on the specified maxGroupCount. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\nIf you need accurate results with high-cardinality properties, set maxGroupCount high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\nexcludedItems. The response accuracy field indicates whether the results are ACCURATE or\nAPPROXIMATE.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.\n","plainTextDescription":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.","example":[]}},"includeNullValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.\n","plainTextDescription":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an exact value.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"},"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"An ISO 8601 timestamp.\n","plainTextDescription":"An ISO 8601 timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value.","plainTextDescription":"Returns objects where the specified array contains a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"ObjectSet which is the root of a MethodObjectSet definition.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which is the root of a MethodObjectSet definition.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter` of type\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter of type\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types whose type class satisfies the given type class predicate.","plainTextDescription":"Returns action types whose type class satisfies the given type class predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"},"type":{"type":"object","object":{"properties":{"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property API name and the load level to apply to the property. You can select a reduced value\nfor arrays and the main value for structs. If the provided load level cannot be applied to the property type,\nthen it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property API name and the load level to apply to the property. You can select a reduced value\nfor arrays and the main value for structs. If the provided load level cannot be applied to the property type,\nthen it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique codex id of a time series.","plainTextDescription":"The unique codex id of a time series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deprecated":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"}}}},"active":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"}}}},"experimental":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"}}}},"example":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.\n","plainTextDescription":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}},"reducedPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property.\n","plainTextDescription":"Describes how an object type implements an interface property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"\n","plainTextDescription":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The duration value.","plainTextDescription":"The duration value.","example":[30]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A measurement of duration.","plainTextDescription":"A measurement of duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"},"type":{"type":"enum","enum":{"values":["THOUSANDS","MILLIONS","BILLIONS"]}},"safety":"SAFE","documentation":{"description":"Scale factor options for large numbers:\n- THOUSANDS: Divide by 1,000 and add \"K\" suffix\n- MILLIONS: Divide by 1,000,000 and add \"M\" suffix\n- BILLIONS: Divide by 1,000,000,000 and add \"B\" suffix\n","plainTextDescription":"Scale factor options for large numbers:\n\nTHOUSANDS: Divide by 1,000 and add \"K\" suffix\nMILLIONS: Divide by 1,000,000 and add \"M\" suffix\nBILLIONS: Divide by 1,000,000,000 and add \"B\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A unique identifier used to associate subscription requests with responses.","plainTextDescription":"A unique identifier used to associate subscription requests with responses.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"createEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"}}}},"deleteEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"}}}},"modifyEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching strings.","plainTextDescription":"A predicate for matching strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"},"type":{"type":"object","object":{"properties":{"allowedValues":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"arraySize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation constraints for a parameter.","plainTextDescription":"Validation constraints for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a section matching the given section rid.","plainTextDescription":"Returns action types with a section matching the given section rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"},"type":{"type":"object","object":{"properties":{"unsupportedType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A short, stable discriminator naming the underlying OMS variant. E.g., `\"derivedProperties\"` for\nderived-properties datasources or `\"unknown\"` for variants the adapter does not recognize.\n","plainTextDescription":"A short, stable discriminator naming the underlying OMS variant. E.g., \"derivedProperties\" for\nderived-properties datasources or \"unknown\" for variants the adapter does not recognize.","example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The property API names that this datasource backs.","plainTextDescription":"The property API names that this datasource backs.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource of a kind not yet exposed in the public API. The `unsupportedType` discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an `\"unknown\"` discriminator. The `properties` list\nenumerates the property API names this datasource backs. The `properties` will be empty for `\"unknown\"`\ndatasources.\n","plainTextDescription":"A datasource of a kind not yet exposed in the public API. The unsupportedType discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an \"unknown\" discriminator. The properties list\nenumerates the property API names this datasource backs. The properties will be empty for \"unknown\"\ndatasources.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"},"type":{"type":"enum","enum":{"values":["FUTURE","PAST"]}},"safety":"SAFE","documentation":{"description":"Direction of a relative datetime offset.","plainTextDescription":"Direction of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structListParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"}}}},"structParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument used for an individual struct field.\n","plainTextDescription":"Represents an argument used for an individual struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by `p` or `properties`. The format expected format is\n`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...`\n\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending \n`:asc` (for ascending) or `:desc` (for descending).\n\nExample: use `orderBy=properties.lastName:asc` to order by a single property, \n`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. \nYou may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`.\n","plainTextDescription":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by p or properties. The format expected format is\norderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending\n:asc (for ascending) or :desc (for descending).\nExample: use orderBy=properties.lastName:asc to order by a single property,\norderBy=properties.lastName,properties.firstName,properties.age:desc to order by multiple properties.\nYou may also use the shorthand p instead of properties such as orderBy=p.lastName:asc.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.\n","plainTextDescription":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.","example":["master"]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \nAll markings from a conjunctive set must be met for access.\n\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\n\nAll markings from a conjunctive set must be met for access.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of a query.","plainTextDescription":"Details about a parameter of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fullLogicRules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns the full metadata for an Action type in the Ontology.","plainTextDescription":"Returns the full metadata for an Action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction.","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"},"type":{"type":"object","object":{"properties":{"useGrouping":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","plainTextDescription":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","example":[]}},"convertNegativeToParenthesis":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, wrap negative numbers in parentheses instead of a minus sign.","plainTextDescription":"If true, wrap negative numbers in parentheses instead of a minus sign.","example":[]}},"minimumIntegerDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"notation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"roundingMode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\n\nExamples:\n- useGrouping: true makes 1234567 display as \"1,234,567\"\n- maximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\n- notation: SCIENTIFIC makes 1234 display as \"1.234E3\"\n","plainTextDescription":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\nExamples:\n\nuseGrouping: true makes 1234567 display as \"1,234,567\"\nmaximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\nnotation: SCIENTIFIC makes 1234 display as \"1.234E3\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","ALL_V2_WITH_DELETIONS","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"geotimeSeriesValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Resolved data values pointed to by a reference.","plainTextDescription":"Resolved data values pointed to by a reference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"}}}},"restrictedView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"}}}},"stream":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"}}}},"mediaSetView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"}}}},"direct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"}}}},"geotimeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"}}}},"editsOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"}}}},"dataset":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"}}}},"table":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.\n","plainTextDescription":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"threeDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"twoDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}}},"typeReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"}}}},"void":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VoidType"}}}},"entrySet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"null":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"NullType"}}}},"interfaceObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Query parameters or outputs.\n","plainTextDescription":"A union of all the types supported by Ontology Query parameters or outputs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.\n","plainTextDescription":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups with the specified width.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the value type in the API in camelCase format.","plainTextDescription":"The name of the value type in the API in camelCase format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"humanReadable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"}}}},"timecode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[false]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\n\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"},"type":{"type":"object","object":{"properties":{"responses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.\n","plainTextDescription":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property bound to a single column in the backing datasource.","plainTextDescription":"A property bound to a single column in the backing datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"},"type":{"type":"enum","enum":{"values":["NANOSECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS"]}},"safety":"SAFE","documentation":{"description":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","plainTextDescription":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked object type.","plainTextDescription":"A reference to the linked object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKeyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object identifier containing an object type API name and primary key.","plainTextDescription":"An object identifier containing an object type API name and primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"numNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.\n","plainTextDescription":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.","example":[]}},"similarityThreshold":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.\n","plainTextDescription":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.","example":[]}},"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet containing the top `numNeighbors` objects with `propertyIdentifier` nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\n\nA non-zero score for each resulting object is returned when the `orderType` in the `orderBy` field is set to\n`relevance`. Note that:\n - Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction \n or intersection with non-nearestNeighbors object sets.\n - If results have scores, the order of the scores will be decreasing (duplicate scores are possible).\n","plainTextDescription":"ObjectSet containing the top numNeighbors objects with propertyIdentifier nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\nA non-zero score for each resulting object is returned when the orderType in the orderBy field is set to\nrelevance. Note that:\n\nScores will not be returned if a nearestNeighbors object set is composed through union, subtraction\nor intersection with non-nearestNeighbors object sets.\nIf results have scores, the order of the scores will be decreasing (duplicate scores are possible).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Reason"},"type":{"type":"object","object":{"properties":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"},"type":{"type":"enum","enum":{"values":["ACCURATE","APPROXIMATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelStrategy"},"type":{"type":"enum","enum":{"values":["PREFER_EXISTING","PREFER_DEFAULT","EXISTING_ONLY","DEFAULT_ONLY"]}},"safety":"SAFE","documentation":{"description":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to `PREFER_EXISTING`.\n\n- `PREFER_EXISTING`: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\n- `PREFER_DEFAULT`: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\n- `EXISTING_ONLY`: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\n- `DEFAULT_ONLY`: use the default channel configured in ontology metadata only; error if none is configured.\n","plainTextDescription":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to PREFER_EXISTING.\n\nPREFER_EXISTING: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\nPREFER_DEFAULT: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\nEXISTING_ONLY: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\nDEFAULT_ONLY: use the default channel configured in ontology metadata only; error if none is configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.\n","plainTextDescription":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying any of the rules in the query\n","plainTextDescription":"Matches intervals satisfying any of the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}},"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"}}}},"groupMember":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"}}}},"objectPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"arraySize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}},"unevaluable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. |\n| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. |\n| `oneOf` | The parameter has a manually predefined set of options. |\n| `range` | The parameter value must be within the defined range. |\n| `stringLength` | The parameter value must have a length within the defined range. |\n| `stringRegexMatch` | The parameter value must match a predefined regular expression. |\n| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |\n","plainTextDescription":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| arraySize | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| groupMember | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| objectPropertyValue | The parameter value must be a property value of an object found within an object set. |\n| objectQueryResult | The parameter value must be the primary key of an object found within an object set. |\n| oneOf | The parameter has a manually predefined set of options. |\n| range | The parameter value must be within the defined range. |\n| stringLength | The parameter value must have a length within the defined range. |\n| stringRegexMatch | The parameter value must match a predefined regular expression. |\n| unevaluable | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesValueBankProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesV2Response"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherText"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A value encrypted with [Cipher](/docs/foundry/cipher/overview/), stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example `CIPHER::{cipherChannelRid}::::CIPHER`).\n","plainTextDescription":"A value encrypted with Cipher, stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example CIPHER::{cipherChannelRid}::::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"},"type":{"type":"enum","enum":{"values":["ASCENDING_NULLS_LAST","DESCENDING_NULLS_LAST"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologyValueTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"},"type":{"type":"enum","enum":{"values":["SECONDS","MILLISECONDS"]}},"safety":"SAFE","documentation":{"description":"Specifies the unit of the input duration value.","plainTextDescription":"Specifies the unit of the input duration value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"},"type":{"type":"enum","enum":{"values":["DATE_FORMAT_RELATIVE_TO_NOW","DATE_FORMAT_DATE","DATE_FORMAT_YEAR_AND_MONTH","DATE_FORMAT_DATE_TIME","DATE_FORMAT_DATE_TIME_SHORT","DATE_FORMAT_TIME","DATE_FORMAT_ISO_INSTANT"]}},"safety":"SAFE","documentation":{"description":"Localized date/time format types.","plainTextDescription":"Localized date/time format types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field starts with the provided value.","plainTextDescription":"Returns objects where the specified field starts with the provided value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}}],"errors":[{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action type is not found, or the user does not have access to it.","plainTextDescription":"The action type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MalformedPropertyFilters"},"errorType":"INVALID_ARGUMENT","parameters":{"malformedPropertyFilter":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`.\n","plainTextDescription":"At least one of requested filters are malformed. Please look at the documentation of PropertyFilter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValue"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyEditsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"editsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"editsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.\n","plainTextDescription":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotSynced"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.\n","plainTextDescription":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupCountExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"groupsCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"groupsLimit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiNamesNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"derivedPropertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested derived property API names already exist on the object set.","plainTextDescription":"At least one of the requested derived property API names already exist on the object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterInterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an interface type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an interface type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedInterfaceBasedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","plainTextDescription":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByValue"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.\n","plainTextDescription":"Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentType"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The `Content-Type` cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.\n","plainTextDescription":"The Content-Type cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkPropertyMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property could not be mapped to a Marketplace installation.","plainTextDescription":"The given property could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinitionOnInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.\n","plainTextDescription":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested properties are not found on the object type.","plainTextDescription":"The requested properties are not found on the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionInvalidInput"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadPropertyNotBackedByMediaSetView"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.\n","plainTextDescription":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortOrder"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortOrder":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.\n","plainTextDescription":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFiltersCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided filters cannot be used together.","plainTextDescription":"The provided filters cannot be used together.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadDestinationNotConfigured"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.\n","plainTextDescription":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFilterable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and\n*Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked *Searchable* and *Selectable* and when it can be used.\n","plainTextDescription":"Results could not be filtered by the requested properties. Please mark the properties as Searchable and\nSelectable in the Ontology Manager to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked Searchable and Selectable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.\n","plainTextDescription":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DuplicateOrderBy"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order includes duplicate properties.","plainTextDescription":"The requested sort order includes duplicate properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionEncounteredUserFacingError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParametersNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"unknownParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"configuredParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field\nto see which ones are available.\n","plainTextDescription":"The provided parameter ID was not found for the action. Please look at the configuredParameterIds field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingInterfaceProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property types are not present on every object type.","plainTextDescription":"The requested interface property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HighScaleComputationNotEnabled"},"errorType":"TIMEOUT","parameters":{},"documentation":{"description":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","plainTextDescription":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value type is not found, or the user does not have access to it.","plainTextDescription":"The value type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidUserId"},"errorType":"INVALID_ARGUMENT","parameters":{"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a user id must be a UUID.","plainTextDescription":"The provided value for a user id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationNestedObjectSetSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"objectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"objectsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.\n","plainTextDescription":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinition"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition was invalid due to shape of query or type checking.","plainTextDescription":"Derived property definition was invalid due to shape of query or type checking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.\n","plainTextDescription":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryNotFound"},"errorType":"NOT_FOUND","parameters":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query is not found, or the user does not have access to it.","plainTextDescription":"The query is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DistinctEnumValuesExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"maxDistinctValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","plainTextDescription":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingValueTypeReference"},"errorType":"INVALID_ARGUMENT","parameters":{"referencedRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","plainTextDescription":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypesSearchNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The search on the property types are not supported. See the `Search Objects` documentation for\na list of supported search queries on different property types.\n","plainTextDescription":"The search on the property types are not supported. See the Search Objects documentation for\na list of supported search queries on different property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryOutputValue"},"errorType":"INVALID_ARGUMENT","parameters":{"outputDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"outputValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.\n","plainTextDescription":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterBaseType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterDataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set is not supported.","plainTextDescription":"The requested object set is not supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryVersionNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query could not be found at the provided version.\n","plainTextDescription":"The query could not be found at the provided version.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested shared property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property was not found on the interface type.","plainTextDescription":"The requested interface property was not found on the interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncingObjectTypes"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more requested object types have been changed in the **Ontology Manager** and changes are currently being\napplied. Wait a few seconds and try again.\n","plainTextDescription":"One or more requested object types have been changed in the Ontology Manager and changes are currently being\napplied. Wait a few seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRange"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation range should include one lt or lte and one gt or gte.\n","plainTextDescription":"Aggregation range should include one lt or lte and one gt or gte.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryMemoryExceededLimit"},"errorType":"TIMEOUT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Memory limits were exceeded for the `Query` execution.\n","plainTextDescription":"Memory limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTimeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Time limits were exceeded for the `Query` execution.\n","plainTextDescription":"Time limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CompositePrimaryKeyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RateLimitReached"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.\n","plainTextDescription":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDefinitionOutOfSync"},"errorType":"CONFLICT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The ontology definition is temporarily out of sync. The indexed definition does not yet \nreflect the latest saved definition for this type. This is typically a transient condition that \nresolves as indexing completes.\n","plainTextDescription":"The ontology definition is temporarily out of sync. The indexed definition does not yet\nreflect the latest saved definition for this type. This is typically a transient condition that\nresolves as indexing completes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBaseTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IncompatibleNestedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.\n","plainTextDescription":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnauthorizedCipherOperation"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to take a specific Cipher operation.\n","plainTextDescription":"The provided token does not have permission to take a specific Cipher operation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentLength"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A `Content-Length` header is required for all uploads, but was missing or invalid.","plainTextDescription":"A Content-Length header is required for all uploads, but was missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplePropertyValuesNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.\n","plainTextDescription":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a runtime error.\n","plainTextDescription":"The authored Query failed to execute because of a runtime error.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to edit this `ObjectType`.\n","plainTextDescription":"The user does not have permission to edit this ObjectType.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSearchable"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Search is not enabled on the specified properties. Please mark the properties as *Searchable*\nin the **Ontology Manager** to enable search on them. There may be a short delay\nbetween the time a property is marked *Searchable* and when it can be used.\n","plainTextDescription":"Search is not enabled on the specified properties. Please mark the properties as Searchable\nin the Ontology Manager to enable search on them. There may be a short delay\nbetween the time a property is marked Searchable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentNotFound"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested attachment is not found, or the client token does not have access to it. \nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.\n","plainTextDescription":"The requested attachment is not found, or the client token does not have access to it.\nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionContainsDuplicateEdits"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The given action request has multiple edits on the same object.","plainTextDescription":"The given action request has multiple edits on the same object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not found, or the client token does not have access to it.","plainTextDescription":"The requested object type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidTransactionEditPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `DataValue` for details on\nhow properties are represented for transaction edits.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of DataValue for details on\nhow properties are represented for transaction edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotFound"},"errorType":"NOT_FOUND","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.\n","plainTextDescription":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParentAttachmentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to parent attachments.\n","plainTextDescription":"The user does not have permission to parent attachments.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid interface property type for duration groupBy.\n","plainTextDescription":"Invalid interface property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DefaultAndNullGroupsNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Exact match groupBy clause cannot specify a default value and allow null values.\n","plainTextDescription":"Exact match groupBy clause cannot specify a default value and allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidGroupId"},"errorType":"INVALID_ARGUMENT","parameters":{"groupId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a group id must be a UUID.","plainTextDescription":"The provided value for a group id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyNotFound"},"errorType":"NOT_FOUND","parameters":{"ontologyRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested Ontology is not found, or the client token does not have access to it.","plainTextDescription":"The requested Ontology is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncing"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a\nfew seconds and try again.\n","plainTextDescription":"The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a\nfew seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property type is not of the expected type.\n","plainTextDescription":"The given property type is not of the expected type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid property type for duration groupBy.\n","plainTextDescription":"Invalid property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksNotSupported"},"errorType":"FAILED_PRECONDITION","parameters":{},"documentation":{"description":"Bulk loading object set links is not supported by Object Storage v1.\n","plainTextDescription":"Bulk loading object set links is not supported by Object Storage v1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleMediaUploadDestinations"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.\n","plainTextDescription":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an object type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an object type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionNotFound"},"errorType":"NOT_FOUND","parameters":{"actionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action is not found, or the user does not have access to it.","plainTextDescription":"The action is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnknownParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"expectedParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameters were not found. Please look at the `knownParameters` field\nto see which ones are available.\n","plainTextDescription":"The provided parameters were not found. Please look at the knownParameters field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionNotSupportedWithTransaction"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The function runtime does not support execution with a transaction.\n","plainTextDescription":"The function runtime does not support execution with a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectSetRidNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object set RID is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object set RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDerivedPropertyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.\n","plainTextDescription":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValueForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsReadOnlyEntity"},"errorType":"INVALID_ARGUMENT","parameters":{"entityTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action request performs edits on a type that is read-only or does not allow edits.","plainTextDescription":"The given action request performs edits on a type that is read-only or does not allow edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidVectorDimension"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"providedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","plainTextDescription":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrdering"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.\n","plainTextDescription":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotResolvable"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.\n","plainTextDescription":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkIdsDoNotExistInActionType"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownUniqueIdentifierLinkIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.\n","plainTextDescription":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortType"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","plainTextDescription":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Failed to find a provided property for a given object.\n","plainTextDescription":"Failed to find a provided property for a given object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRidNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type RID is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The object the user is attempting to create already exists.\n","plainTextDescription":"The object the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiNameNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"ontologyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","plainTextDescription":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object set is not found, or the client token does not have access to it.","plainTextDescription":"The requested object set is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The link type is not found, or the user does not have access to it.","plainTextDescription":"The link type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMemoryExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"memoryUsedBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"memoryLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFiltersNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for\na list of supported property filters.\n","plainTextDescription":"At least one of the requested property filters are not supported. See the documentation of PropertyFilter for\na list of supported property filters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The link the user is attempting to create already exists.\n","plainTextDescription":"The link the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDepthExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"depth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"depthLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.\n","plainTextDescription":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidRangeQuery"},"errorType":"INVALID_ARGUMENT","parameters":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}},"field":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The specified query range filter is invalid.\n","plainTextDescription":"The specified query range filter is invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ViewObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.\n","plainTextDescription":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"metricType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.\n","plainTextDescription":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by interface property type.\n","plainTextDescription":"Range group by is not supported by interface property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `PropertyValue` for details on\nhow properties are represented.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of PropertyValue for details on\nhow properties are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionValidationFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The validation failed for the given action parameters. Please use the `validateAction` endpoint for more\ndetails.\n","plainTextDescription":"The validation failed for the given action parameters. Please use the validateAction endpoint for more\ndetails.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSortable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and\n*Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay\nbetween the time a property is set to *Searchable* and *Sortable* and when it can be used.\n","plainTextDescription":"Results could not be ordered by the requested properties. Please mark the properties as Searchable and\nSortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay\nbetween the time a property is set to Searchable and Sortable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleGroupByOnFieldNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"duplicateFields":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation cannot group by on the same field multiple times.\n","plainTextDescription":"Aggregation cannot group by on the same field multiple times.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The linked object with the given primary key is not found, or the user does not have access to it.","plainTextDescription":"The linked object with the given primary key is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFoundOnObject"},"errorType":"INVALID_ARGUMENT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectPropertyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","plainTextDescription":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface link type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface link type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectChanged"},"errorType":"CONFLICT","parameters":{"primaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An object used by this `Action` was changed by someone else while the `Action` was running.\n","plainTextDescription":"An object used by this Action was changed by someone else while the Action was running.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditedPropertiesNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.\n","plainTextDescription":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionTimedOut"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidApplyActionOptionCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidCombination":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given options are individually valid but cannot be used in the given combination.","plainTextDescription":"The given options are individually valid but cannot be used in the given combination.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConsistentSnapshotError"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.\n","plainTextDescription":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SimilarityThresholdOutOfRange"},"errorType":"INVALID_ARGUMENT","parameters":{"providedThreshold":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","plainTextDescription":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFilterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyFilterValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\n`isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type.\n","plainTextDescription":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\nisNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryEncounteredUserFacingError"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored Query failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsNotSupportedWithMarketplace"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Returning action edits is not supported when using marketplace bindings.\n","plainTextDescription":"Returning action edits is not supported when using marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypesNotSynced"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.\n","plainTextDescription":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypesNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface types were not found, or the client token does not have access to it.","plainTextDescription":"The requested interface types were not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingSharedProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property types are not present on every object type.","plainTextDescription":"The requested shared property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrderingWithNullValues"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.\n","plainTextDescription":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"fileSizeBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fileLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.\n","plainTextDescription":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsModifiedConcurrently"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.\n","plainTextDescription":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyExactMatchingNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that does not support exact matching is used in a setting that requires exact matching.","plainTextDescription":"A property that does not support exact matching is used in a setting that requires exact matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeDoesNotSupportNearestNeighbors"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","plainTextDescription":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotCipherFormatted"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHER::::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHERCIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object is not found, or the client token does not have access to it.","plainTextDescription":"The requested object is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidOrderType"},"errorType":"INVALID_ARGUMENT","parameters":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This query type does not support the provided order type","plainTextDescription":"This query type does not support the provided order type","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the **Ontology Manager**.\n","plainTextDescription":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TooManyNearestNeighborsRequested"},"errorType":"INVALID_ARGUMENT","parameters":{"requestedNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"maxNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","plainTextDescription":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceBasedObjectSetNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set type is not supported for interface-based object sets.","plainTextDescription":"The requested object set type is not supported for interface-based object sets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BranchNotSupportedWithMarketplaceQuery"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The branch parameter is not supported when executing queries with marketplace bindings.\n","plainTextDescription":"The branch parameter is not supported when executing queries with marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UndecryptableValue"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER:::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditMissingPrimaryKey"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.\n","plainTextDescription":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by property type.\n","plainTextDescription":"Range group by is not supported by property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidFields"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given field does not match the expected pattern. For example, an Ontology object property `id`\nshould be written `properties.id`.\n","plainTextDescription":"The value of the given field does not match the expected pattern. For example, an Ontology object property id\nshould be written properties.id.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"localObjectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Required parameters are missing. Please look at the `parameters` field to see which required parameters are\nmissing from the request.\n","plainTextDescription":"Required parameters are missing. Please look at the parameters field to see which required parameters are\nmissing from the request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRidAlreadyExists"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided attachment RID already exists and cannot be overwritten.\n","plainTextDescription":"The provided attachment RID already exists and cannot be overwritten.","example":[]}}]}; +export const OntologiesV1: Namespace = {"name":"Ontologies","version":"v1","outputAuditVersions":"V3_ONLY","resources":[{"singleton":false,"documentation":{"description":"Ontologies are categorizations of data into real-world concepts. Those concepts are represented by object types, properties, link types, and action types. Together, these concepts form a descriptive object graph that links together all the key entities in an organization.\n\nFor more information, please refer to the [Ontology](/docs/foundry/ontology/overview/) user documentation.\n\n:::callout{theme=neutral title=Note}\nOntology changes are eventually consistent, and it may take few minutes for the API to reflect new Ontologies.\nAfter adding a new Ontology, the API may return an `OntologyNotFound` error for a few minutes.\n:::\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Ontology"},"pluralName":"Ontologies","operations":[{"name":"listOntologies","verb":"list","documentation":{"description":"Lists the Ontologies visible to the current user.\n","plainTextDescription":"Lists the Ontologies visible to the current user.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies","httpMethod":"GET","parameters":[],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"},{"apiName":"shared-ontology","displayName":"Shared ontology","description":"The ontology shared with our suppliers","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOntology","verb":"get","documentation":{"description":"Gets a specific ontology with the given Ontology RID.\n","plainTextDescription":"Gets a specific ontology with the given Ontology RID.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Ontology"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"This represents an object type within a Foundry Ontology. For more information, review the \n[Object Type](/docs/foundry/object-link-types/object-types-overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ObjectType"},"pluralName":"ObjectTypes","operations":[{"name":"listObjectTypes","verb":"list","documentation":{"description":"Lists the object types for the given Ontology.\n\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.\n","plainTextDescription":"Lists the object types for the given Ontology.\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","primaryKey":["employeeId"],"properties":{"employeeId":{"baseType":"Integer"},"fullName":{"baseType":"String"},"office":{"description":"The unique ID of the employee's primary assigned office","baseType":"String"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","baseType":"Date"}},"rid":"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"},{"apiName":"office","description":"A physical location (not including rented co-working spaces)","primaryKey":["officeId"],"properties":{"officeId":{"baseType":"String"},"address":{"description":"The office's physical address (not necessarily shipping address)","baseType":"String"},"capacity":{"description":"The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)","baseType":"Integer"}},"rid":"ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectType","verb":"get","documentation":{"description":"Gets a specific object type with the given API name.\n","plainTextDescription":"Gets a specific object type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes/{objectType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","primaryKey":["employeeId"],"properties":{"employeeId":{"baseType":"Integer"},"fullName":{"baseType":"String"},"office":{"description":"The unique ID of the employee's primary assigned office","baseType":"String"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","baseType":"Date"}},"rid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOutgoingLinkTypes","verb":"listOutgoingLinkTypes","documentation":{"description":"List the outgoing links for an object type.\n","plainTextDescription":"List the outgoing links for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager** application.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager application.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Flight"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned.","plainTextDescription":"The desired size of the page to be returned.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"originAirport","objectTypeApiName":"Airport","cardinality":"ONE","foreignKeyPropertyApiName":"originAirportId"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingLinkType","verb":"getOutgoingLinkType","documentation":{"description":"Get an outgoing link for an object type.\n","plainTextDescription":"Get an outgoing link for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager** application.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager application.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the outgoing link.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the outgoing link.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"directReport","objectTypeApiName":"Employee","cardinality":"MANY"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An action type represents a set of changes and logic that can be applied in the Ontology. Action types are \ncreated in the **Ontology Manager**. For more information, refer to the\n[action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ActionType"},"pluralName":"ActionTypes","operations":[{"name":"listActionTypes","verb":"list","documentation":{"description":"Lists the action types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the action types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actionTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"baseType":"Integer"},"newTitle":{"baseType":"String"},"newCompensation":{"baseType":"Decimal"}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},{"apiName":"move-office","description":"Update an office's physical location","parameters":{"officeId":{"baseType":"String"},"newAddress":{"description":"The office's new physical address (not necessarily shipping address)","baseType":"String"},"newCapacity":{"description":"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)","baseType":"Integer"}},"rid":"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionType","verb":"get","documentation":{"description":"Gets a specific action type with the given API name.\n","plainTextDescription":"Gets a specific action type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action type.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action type.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionTypeApiName","documentation":{"description":"The name of the action type in the API.\n","plainTextDescription":"The name of the action type in the API.","example":["promote-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"baseType":"Integer"},"newTitle":{"baseType":"String"},"newCompensation":{"baseType":"Decimal"}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Action represents one application of an action type. You may use them in the API to apply changes to the \nOntology. For more information, refer to the [action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Action"},"pluralName":"Actions","operations":[{"name":"applyAction","verb":"apply","documentation":{"description":"Applies an action using the given parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n","plainTextDescription":"Applies an action using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that parameter default values are not currently supported by\nthis endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/apply","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]},{"name":"applyActionBatch","verb":"applyBatch","documentation":{"description":"Applies multiple actions (of the same Action Type) using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and\n[notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint.\n","plainTextDescription":"Applies multiple actions (of the same Action Type) using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\nNote that parameter default values and\nnotifications are not currently supported by this endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"applyActionAsync","verb":"applyAsync","documentation":{"description":"Applies an action asynchronously using the given parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently\nsupported by this endpoint.\n","plainTextDescription":"Applies an action asynchronously using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that parameter default values are not currently\nsupported by this endpoint.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Represents a boolean value that restricts an endpoint to preview mode when set to true.\n","plainTextDescription":"Represents a boolean value that restricts an endpoint to preview mode when set to true.","example":[true]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"id":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367","operationType":"applyActionAsync","status":"RUNNING","stage":"RUNNING_SUBMISSION_CHECKS"}]}]},"body":{"type":"accepted","accepted":{"responseType":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"code":"202"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAsyncActionStatus","verb":"getOperationStatus","documentation":{"example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionRid","documentation":{"example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Represents a boolean value that restricts an endpoint to preview mode when set to true.\n","plainTextDescription":"Represents a boolean value that restricts an endpoint to preview mode when set to true.","example":[true]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response","plainTextDescription":"Success response","example":[{"id":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367","operationType":"applyActionAsync","status":"SUCCESSFUL","result":{"type":"success"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"validateAction","verb":"validate","documentation":{"description":"Validates if an action can be run with the given set of parameters.\nThe response contains the evaluation of parameters and **submission criteria**\nthat determine if the request is `VALID` or `INVALID`.\nFor performance reasons, validations will not consider existing objects or other data in Foundry.\nFor example, the uniqueness of a primary key or the existence of a user ID will not be checked.\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint. Unspecified parameters will be given a default value of `null`.\n","plainTextDescription":"Validates if an action can be run with the given set of parameters.\nThe response contains the evaluation of parameters and submission criteria\nthat determine if the request is VALID or INVALID.\nFor performance reasons, validations will not consider existing objects or other data in Foundry.\nFor example, the uniqueness of a primary key or the existence of a user ID will not be checked.\nNote that parameter default values are not currently supported by\nthis endpoint. Unspecified parameters will be given a default value of null.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyLogicAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/actions/{actionType}/validate","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The API name of the action to validate. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to validate. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":"2","firstName":"Chuck","lastName":"Jones","age":17,"date":"2021-05-01","numbers":[1,2,3],"hasObjectSet":true,"objectSet":"ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623","reference":"Chuck","percentage":41.3,"differentObjectId":"2"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"result":"INVALID","submissionCriteria":[{"configuredFailureMessage":"First name can not match the first name of the referenced object.","result":"INVALID"}],"parameters":{"age":{"result":"INVALID","evaluatedConstraints":[{"type":"range","gte":18}],"required":true},"id":{"result":"VALID","evaluatedConstraints":[],"required":true},"date":{"result":"VALID","evaluatedConstraints":[],"required":true},"lastName":{"result":"VALID","evaluatedConstraints":[{"type":"oneOf","options":[{"displayName":"Doe","value":"Doe"},{"displayName":"Smith","value":"Smith"},{"displayName":"Adams","value":"Adams"},{"displayName":"Jones","value":"Jones"}],"otherValuesAllowed":true}],"required":true},"numbers":{"result":"VALID","evaluatedConstraints":[{"type":"arraySize","lte":4,"gte":2}],"required":true},"differentObjectId":{"result":"VALID","evaluatedConstraints":[{"type":"objectPropertyValue"}],"required":false},"firstName":{"result":"VALID","evaluatedConstraints":[],"required":true},"reference":{"result":"VALID","evaluatedConstraints":[{"type":"objectQueryResult"}],"required":false},"percentage":{"result":"VALID","evaluatedConstraints":[{"type":"range","lt":100,"gte":0}],"required":true},"objectSet":{"result":"VALID","evaluatedConstraints":[],"required":true},"attachment":{"result":"VALID","evaluatedConstraints":[],"required":false},"hasObjectSet":{"result":"VALID","evaluatedConstraints":[],"required":false},"multipleAttachments":{"result":"VALID","evaluatedConstraints":[{"type":"arraySize","gte":0}],"required":false}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using [Query Functions](/docs/foundry/functions/query-functions/).","example":[]},"component":{"namespaceName":"Ontologies","localName":"QueryType"},"pluralName":"QueryTypes","operations":[{"name":"listQueryTypes","verb":"list","documentation":{"description":"Lists the query types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the query types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/queryTypes","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 100.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 100.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"baseType":"String","description":"The city to search for employees in","required":true}},"output":"Array>","rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"},{"apiName":"getAverageTenureOfEmployees","displayName":"Get Average Tenure","description":"Gets the average tenure of all employees","parameters":{"employees":{"baseType":"String","description":"An object set of the employees to calculate the average tenure of","required":true},"useMedian":{"baseType":"Boolean","description":"An optional flag to use the median instead of the mean, defaults to false","required":false}},"output":"Double","rid":"ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400","version":"2.1.1"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getQueryType","verb":"get","documentation":{"description":"Gets a specific query type with the given API name.\n","plainTextDescription":"Gets a specific query type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the query type. To find the API name, use the **List query types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the query type. To find the API name, use the List query types endpoint or\ncheck the Ontology Manager.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"baseType":"String","description":"The city to search for employees in","required":true}},"output":"Array>","rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using [Query Functions](/docs/foundry/functions/query-functions/).","example":[]},"component":{"namespaceName":"Ontologies","localName":"Query"},"pluralName":"Queries","operations":[{"name":"executeQuery","verb":"execute","documentation":{"description":"Executes a Query using the given parameters. Optional parameters do not need to be supplied.\n","plainTextDescription":"Executes a Query using the given parameters. Optional parameters do not need to be supplied.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the Query to execute.\n","plainTextDescription":"The API name of the Query to execute.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"attribution","documentation":{"description":"The Attribution to be used when executing this request.\n","plainTextDescription":"The Attribution to be used when executing this request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"city":"New York"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"value":["EMP546","EMP609","EMP989"]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Object is a data container for a specific instance of an [Object Type](/docs/foundry/object-link-types/object-types-overview/). For instance, the Employee object type may contain data about several employees, and each one is represented as a single Object.\n\n## Filter objects\n\nAnytime you request a list of objects using the List Objects endpoint, you can add filters to limit which objects you get back. Filters are given as query parameters of the form:\n\n```\nproperties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}\n```\n\nFor instance, the following filter will return only objects with a property called \"firstName\" that has the exact value of \"John\".\n\n```\nproperties.firstName.eq=John\n```\n\nProperty names in URLs are case-insensitive, and as a shortcut, you can write `p.` instead of `properties.`. The above example could also be written like this.\n\n```\np.firstname.eq=John\n```\n\n| Filter | Description | Valid property types | Example Usage |\n|----------|--------------------------|-------------------------------------------------------|------------------------------------|\n| contains | Array contains value | arrays | properties.names.contains=John |\n| eq | Exactly equal | all types except arrays and attachments | properties.firstName.eq=John |\n| neq | Not exactly equal | all types except arrays and attachments | properties.firstName.neq=John |\n| lt | Less than | date, timestamp, byte, integer, long, double, decimal | properties.age.lt=40 |\n| lte | Less than or equal to | date, timestamp, byte, integer, long, double, decimal | properties.age.lte=40 |\n| gt | Greater than | date, timestamp, byte, integer, long, double, decimal | properties.age.gt=40 |\n| gte | Greater than or equal to | date, timestamp, byte, integer, long, double, decimal | properties.age.gte=40 |\n| isNull | Value is null | all types except attachments | properties.firstName.isNull=false |\n\nIf multiple `contains` or `eq` filters are applied to the same property, then objects that have any of the given values for the specified property will be matched. If two range filters are applied to the same property (e.g. `lt` and `gte`), then only objects that match both constraints will be returned.\n\nAs a more complex example, the following filter will match people named John or Anna who were born in the 1980s, whose interests include tennis or golf, and who have a (non-null) street address. It is written on multiple lines for readability.\n\n```\n?p.firstName.eq=John\n&p.firstName.eq=Anna\n&p.birthDate.gte=1980-01-01\n&p.birthDate.lt=1990-01-01\n&p.interests.contains=tennis\n&p.interests.contains=golf\n&p.streetAddress.isNull=false\n```\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyObject"},"pluralName":"OntologyObjects","operations":[{"name":"listObjects","verb":"list","documentation":{"description":"Lists the objects for the given Ontology and object type.\n\nThis endpoint supports filtering objects.\nSee the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the objects for the given Ontology and object type.\nThis endpoint supports filtering objects.\nSee the Filtering Objects documentation for details.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","properties":{"id":50030,"firstName":"John","lastName":"Doe"}},{"rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","properties":{"id":20090,"firstName":"John","lastName":"Haymore"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObject","verb":"get","documentation":{"description":"Gets a specific object with the given primary key.\n","plainTextDescription":"Gets a specific object with the given primary key.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the requested object. To look up the expected primary key for your object type, use the\n`Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested object. To look up the expected primary key for your object type, use the\nGet object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","properties":{"id":50030,"firstName":"John","lastName":"Doe"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listLinkedObjects","verb":"listLinkedObjects","documentation":{"description":"Lists the linked objects for a specific object and the given link type.\n\nThis endpoint supports filtering objects.\nSee the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/ontology-object-basics#filter-objects) for details.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the linked objects for a specific object and the given link type.\nThis endpoint supports filtering objects.\nSee the Filtering Objects documentation for details.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object from which the links originate. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","properties":{"id":80060,"firstName":"Anna","lastName":"Smith"}},{"rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","properties":{"id":51060,"firstName":"James","lastName":"Matthews"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getLinkedObject","verb":"getLinkedObject","documentation":{"description":"Get a specific linked object that originates from another object. If there is no link between the two objects,\nLinkedObjectNotFound is thrown.\n","plainTextDescription":"Get a specific linked object that originates from another object. If there is no link between the two objects,\nLinkedObjectNotFound is thrown.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}","httpMethod":"GET","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\n**List ontologies** endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**.","plainTextDescription":"The API name of the object from which the links originate. To find the API name, use the List object types endpoint or check the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the link originates. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the link originates. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkedObjectPrimaryKey","documentation":{"description":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the Get object type endpoint (passing the linked object type) or the Ontology Manager.","example":[80060]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"properties","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","properties":{"id":80060,"firstName":"Anna","lastName":"Smith"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchObjects","verb":"search","documentation":{"description":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| prefix | The provided property starts with the provided term. | string |\n| phrase | The provided property contains the provided term as a substring. | string |\n| anyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| allTerms | The provided property contains all the terms separated by whitespace. | string |\n\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\n\nThe `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a `nextPageToken`, the remaining\nobjects can be retrieved by requesting subsequent pages.\n","plainTextDescription":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| prefix | The provided property starts with the provided term. | string |\n| phrase | The provided property contains the provided term as a substring. | string |\n| anyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| allTerms | The provided property contains all the terms separated by whitespace. | string |\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'\"~). Periods (.) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\nThe pageSize parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a nextPageToken, the remaining\nobjects can be retrieved by requesting subsequent pages.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/search","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The type of the requested objects.","plainTextDescription":"The type of the requested objects.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"query":{"not":{"field":"properties.age","eq":21}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"properties":{"lastName":"smith","firstName":"john","age":21},"rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"aggregateObjects","verb":"aggregate","documentation":{"description":"Perform functions on object fields in the specified ontology and object type.\n","plainTextDescription":"Perform functions on object fields in the specified ontology and object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate","httpMethod":"POST","parameters":[{"name":"ontologyRid","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology that contains the objects.","example":["ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The type of the object to aggregate on.","plainTextDescription":"The type of the object to aggregate on.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"aggregation":[{"type":"min","field":"properties.tenure","name":"min_tenure"},{"type":"avg","field":"properties.tenure","name":"avg_tenure"}],"query":{"not":{"field":"properties.name","eq":"john"}},"groupBy":[{"field":"properties.startDate","type":"range","ranges":[{"gte":"2020-01-01","lt":"2020-06-01"}]},{"field":"properties.city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"properties.startDate":{"gte":"2020-01-01","lt":"2020-06-01"},"properties.city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"properties.startDate":{"gte":"2020-01-01","lt":"2020-06-01"},"properties.city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Attachment is a file that acts like a parameter of an object. Attachments are uploaded as temporary files \nand attached to objects via actions. Attachments are configured in the **Ontology Manager**. For more information, \nplease checkout the [Upload attachments](/docs/foundry/action-types/upload-attachments/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Attachment"},"pluralName":"Attachments","operations":[{"name":"uploadAttachment","verb":"upload","documentation":{"description":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n","plainTextDescription":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.","example":[]},"releaseStage":"STABLE","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v1/attachments/upload","httpMethod":"POST","parameters":[{"name":"Content-Length","documentation":{"description":"The size in bytes of the file content being uploaded.","plainTextDescription":"The size in bytes of the file content being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentLength"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Type","documentation":{"description":"The media type of the file being uploaded.","plainTextDescription":"The media type of the file being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentType"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"The name of the file being uploaded.","plainTextDescription":"The name of the file being uploaded.","example":["My Image.jpeg"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Attachment"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentContent","verb":"read","documentation":{"description":"Get the content of an attachment.\n","plainTextDescription":"Get the content of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/attachments/{attachmentRid}/content","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachment","verb":"get","documentation":{"description":"Get the metadata of an attachment.\n","plainTextDescription":"Get the metadata of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v1/attachments/{attachmentRid}","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Attachment"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]}],"components":[{"locator":{"namespaceName":"Ontologies","localName":"TableRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry table.","plainTextDescription":"The RID of a Foundry table.","example":["ri.tables.main.table.beb574f7-019c-4a01-abd1-ff3c97bfaec8"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"}}}},"prefix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"}}}},"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"}}}},"allTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"}}}},"phrase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"}}}},"anyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface property implementations of that object type.","plainTextDescription":"Map from object type to the interface property implementations of that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of an input to a function.\n","plainTextDescription":"The name of an input to a function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the property is backed by a restricted view that does not support property securities.","plainTextDescription":"Indicates the property is backed by a restricted view that does not support property securities.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"},"type":{"type":"object","object":{"properties":{"center":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"}}},"safety":"UNSAFE","documentation":{"example":[]}},"distance":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Distance"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The coordinate point to use as the center of the distance query.\n","plainTextDescription":"The coordinate point to use as the center of the distance query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeReferences":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a parameter against the configured constraints.","plainTextDescription":"Represents the validity of a parameter against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the PropertyType","plainTextDescription":"The API name of the PropertyType","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"},"type":{"type":"object","object":{"properties":{"position":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Position"}}},"safety":"UNSAFE","documentation":{"example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The underlying data values pointed to by a GeotimeSeriesReference.","plainTextDescription":"The underlying data values pointed to by a GeotimeSeriesReference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current time argument in a logic rule.","plainTextDescription":"Represents the current time argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionMode"},"type":{"type":"enum","enum":{"values":["ASYNC","RUN","VALIDATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types that have been modified within a scenario.\n","plainTextDescription":"The object types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an approximate number of distinct values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","plainTextDescription":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadOntologyMetadataRequest"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","plainTextDescription":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version corresponding to a codex template.","plainTextDescription":"The version corresponding to a codex template.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have been edited within the scenario.","plainTextDescription":"The list of objects that have been edited within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have been edited within a scenario for a given object type.\n\nThe Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName`\nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The objects that have been edited within a scenario for a given object type.\nThe Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched intervals must occur in order.","plainTextDescription":"If true, the matched intervals must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying all the rules in the query\n","plainTextDescription":"Matches intervals satisfying all the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a struct field in the Ontology.","plainTextDescription":"The name of a struct field in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"timeSeriesSyncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the time series.\n","plainTextDescription":"The set of properties that are bound to the time series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a time series sync, providing values for time-dependent properties.\n","plainTextDescription":"An object type datasource backed by a time series sync, providing values for time-dependent properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"},"type":{"type":"object","object":{"properties":{"ontology":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BranchMetadata"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with an api name matching the given string predicate.","plainTextDescription":"Returns action types with an api name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`.","plainTextDescription":"Represents the API POST body when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequest"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","plainTextDescription":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed \"Other\" value** toggle in the **Ontology Manager**.","plainTextDescription":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the Allowed \"Other\" value toggle in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter has a manually predefined set of options.\n","plainTextDescription":"The parameter has a manually predefined set of options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Greater than or equal.","plainTextDescription":"Greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Less than or equal.","plainTextDescription":"Less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Bounds on the size of an array-typed parameter.","plainTextDescription":"Bounds on the size of an array-typed parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"style":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"}}},"safety":"SAFE","documentation":{"example":[]}},"currencyCode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)\n","plainTextDescription":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"},"type":{"type":"object","object":{"properties":{"directSourceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.\n","plainTextDescription":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Parameter"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action or query.","plainTextDescription":"Details about a parameter of an action or query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter`, whose value type is\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter, whose value type is\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"},"type":{"type":"object","object":{"properties":{"numberType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for numeric formatting options.","plainTextDescription":"Wrapper for numeric formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the minimum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.\n","plainTextDescription":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A message containing link updates for a subscription.","plainTextDescription":"A message containing link updates for a subscription.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The numeric value of the time offset. Negative values indicate the past, positive values the future.\n","plainTextDescription":"The numeric value of the time offset. Negative values indicate the past, positive values the future.","example":[-7]}},"timeUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A point in time specified relative to query execution time.","plainTextDescription":"A point in time specified relative to query execution time.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they are revertible.","plainTextDescription":"Returns action types based on whether they are revertible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"},"type":{"type":"enum","enum":{"values":["STANDARD","SCIENTIFIC","ENGINEERING","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Number notation style options:\n- STANDARD: Regular number display (\"1,234\")\n- SCIENTIFIC: Scientific notation (\"1.234E3\")\n- ENGINEERING: Engineering notation (\"1.234E3\")\n- COMPACT: Compact notation (\"1.2K\")\n","plainTextDescription":"Number notation style options:\n\nSTANDARD: Regular number display (\"1,234\")\nSCIENTIFIC: Scientific notation (\"1.234E3\")\nENGINEERING: Engineering notation (\"1.234E3\")\nCOMPACT: Compact notation (\"1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the property in the API. To find the API name for your property, use the `Get object type`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the property in the API. To find the API name for your property, use the Get object type\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"description":"The suggested visibility of the object type.","plainTextDescription":"The suggested visibility of the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Represents a filter used on properties.\n\nEndpoints that accept this supports optional parameters that have the form:\n`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects.\nFor instance, you may use `properties.firstName.eq=John` to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\n\nThe following are a list of supported property filters:\n\n- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties\n that have at least one of the provided values. If multiple query parameters are provided, then objects\n that have any of the given values for the specified property will be matched.\n- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided\n property. If multiple query parameters are provided, then objects that have any of the given values\n will be matched. For instance, if the user provides a request by doing\n `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property\n of either John or Anna will be matched. This filter is supported on all property types except Arrays.\n- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values.\n Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values\n will be excluded from the result.\n- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt`\n `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater\n than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\n- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null.\n This filter is supported on all property types.\n","plainTextDescription":"Represents a filter used on properties.\nEndpoints that accept this supports optional parameters that have the form:\nproperties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString} to filter the returned objects.\nFor instance, you may use properties.firstName.eq=John to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\nThe following are a list of supported property filters:\n\nproperties.{propertyApiName}.contains - supported on arrays and can be used to filter array properties\nthat have at least one of the provided values. If multiple query parameters are provided, then objects\nthat have any of the given values for the specified property will be matched.\nproperties.{propertyApiName}.eq - used to filter objects that have the exact value for the provided\nproperty. If multiple query parameters are provided, then objects that have any of the given values\nwill be matched. For instance, if the user provides a request by doing\n?properties.firstName.eq=John&properties.firstName.eq=Anna, then objects that have a firstName property\nof either John or Anna will be matched. This filter is supported on all property types except Arrays.\nproperties.{propertyApiName}.neq - used to filter objects that do not have the provided property values.\nSimilar to the eq filter, if multiple values are provided, then objects that have any of the given values\nwill be excluded from the result.\nproperties.{propertyApiName}.lt, properties.{propertyApiName}.lte, properties.{propertyApiName}.gt\nproperties.{propertyApiName}.gte - represent less than, less than or equal to, greater than, and greater\nthan or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\nproperties.{propertyApiName}.isNull - used to filter objects where the provided property is (or is not) null.\nThis filter is supported on all property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Icon"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"blueprint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","plainTextDescription":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \n \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the derived property that will be returned.\n","plainTextDescription":"The name of the derived property that will be returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Ontology"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the `List shared property types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the List shared property types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the webhook with the given rid.","plainTextDescription":"Returns action types which reference the webhook with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only *properties*, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.\n","plainTextDescription":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only properties, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioRequest"},"type":{"type":"object","object":{"properties":{"base":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for creating an ontology scenario.","plainTextDescription":"The request payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"allOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"}}}},"match":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"}}}},"anyOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"}}}},"prefixOnLastToken":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"}}}},"fuzzy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Sub-rule used for evaluating an IntervalQuery","plainTextDescription":"Sub-rule used for evaluating an IntervalQuery","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a \nvariety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a\nvariety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A reference to an Ontology object property with the form `properties.{propertyApiName}`.","plainTextDescription":"A reference to an Ontology object property with the form properties.{propertyApiName}.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A reference to a UniqueIdentifierArgument linkId defined for this action type.\n","plainTextDescription":"A reference to a UniqueIdentifierArgument linkId defined for this action type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the action type in the API. To find the API name for your Action Type, use the `List action types`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the action type in the API. To find the API name for your Action Type, use the List action types\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"},"type":{"type":"object","object":{"properties":{"shouldLoadObjectRids":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of \nmilliseconds to the execution time, and should be avoided where not needed.\n","plainTextDescription":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of\nmilliseconds to the execution time, and should be avoided where not needed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Optional features to toggle when generating the object loading response.\n","plainTextDescription":"Optional features to toggle when generating the object loading response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"},"type":{"type":"object","object":{"properties":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}},"tense":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A datetime expressed as an offset from the current time.","plainTextDescription":"A datetime expressed as an offset from the current time.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.\n","plainTextDescription":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceObjectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructType"},"type":{"type":"object","object":{"properties":{"structFieldTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"mainValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A single struct field's mapping where `apiName` is the name of a struct field.\n","plainTextDescription":"A single struct field's mapping where apiName is the name of a struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"}}}},"user":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a parameter whose name matches the given string predicate.","plainTextDescription":"Returns action types with a parameter whose name matches the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"},"type":{"type":"object","object":{"properties":{"formatStyle":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"}}},"safety":"UNSAFE","documentation":{"example":[]}},"precision":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"}}}}},"safety":"SAFE","documentation":{"example":[]}},"baseValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numeric values representing time durations.\n- Human readable: 3661 seconds displays as \"1h 1m 1s\"\n- Timecode: 3661 seconds displays as \"01:01:01\"\n","plainTextDescription":"Format numeric values representing time durations.\n\nHuman readable: 3661 seconds displays as \"1h 1m 1s\"\nTimecode: 3661 seconds displays as \"01:01:01\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be within the defined range.\n","plainTextDescription":"The parameter value must be within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set \nby removing the request from subsequent ObjectSetStreamSubscribeRequests.\n","plainTextDescription":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set\nby removing the request from subsequent ObjectSetStreamSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object locators to report link changes on.","plainTextDescription":"A list of object locators to report link changes on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayTimezone":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for timestamp property values.","plainTextDescription":"Formatting configuration for timestamp property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface-to-object-type mapping for that object type.","plainTextDescription":"Map from object type to the interface-to-object-type mapping for that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"},"type":{"type":"enum","enum":{"values":["DAYS","MONTHS","QUARTERS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Negates a numeric value.\n","plainTextDescription":"Negates a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values of the object at the time of creation.\nMaps property API names to their values.\n","plainTextDescription":"The property values of the object at the time of creation.\nMaps property API names to their values.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`foreignKeyPropertyApiName` is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.\n","plainTextDescription":"foreignKeyPropertyApiName is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"scenarioReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ScenarioReferenceType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"geohash":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeohashType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Action parameters.\n","plainTextDescription":"A union of all the types supported by Ontology Action parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid UUID (Universally Unique Identifier).","plainTextDescription":"The string must be a valid UUID (Universally Unique Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"},"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\n`List ontologies` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"rolling":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"}}}},"periodic":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"}}}},"cumulative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.\n","plainTextDescription":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.\n","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"structField":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"}}}},"propertyWithLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"}}}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"}}}},"primaryKeyProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An identifier used to select properties or struct fields.","plainTextDescription":"An identifier used to select properties or struct fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified numeric range.\n","plainTextDescription":"The parameter value must fall within the specified numeric range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Randomly generated identifier for an object type's datasource.\n","plainTextDescription":"Randomly generated identifier for an object type's datasource.","example":["ri.ontology.main.datasource.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"},"type":{"type":"object","object":{"properties":{"selectedObjects":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.\n","plainTextDescription":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"},"type":{"type":"object","object":{"properties":{"minimumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"uniqueValues":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"valueConstraint":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"structFields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a singleton struct parameter.","plainTextDescription":"Represents the validity of a singleton struct parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponse"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the property values of the object.","plainTextDescription":"A map of the property values of the object.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Queries support either a vector matching the embedding model defined on the property, or text that is \nautomatically embedded.\n","plainTextDescription":"Queries support either a vector matching the embedding model defined on the property, or text that is\nautomatically embedded.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"relativeStartTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"relativeEndTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"timeZoneId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.\n","plainTextDescription":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.","example":["America/New_York"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.\n\nExamples:\n- Last 7 days: relativeStartTime = {value: -7, timeUnit: DAY}, relativeEndTime = {value: 0, timeUnit: DAY}\n- This month: relativeStartTime = {value: 0, timeUnit: MONTH}, relativeEndTime = {value: 1, timeUnit: MONTH}\n","plainTextDescription":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.\nExamples:\n\nLast 7 days: relativeStartTime = {value: -7, timeUnit: DAY}, relativeEndTime = {value: 0, timeUnit: DAY}\nThis month: relativeStartTime = {value: 0, timeUnit: MONTH}, relativeEndTime = {value: 1, timeUnit: MONTH}","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"},"type":{"type":"object","object":{"properties":{"streamRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry stream.","plainTextDescription":"An object type datasource backed by a Foundry stream.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"}}}},"doesNotIntersectBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"}}}},"relativeDateRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"}}}},"wildcard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"}}}},"withinDistanceOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"}}}},"withinBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"}}}},"intersectsBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"}}}},"containsAllTermsInOrderPrefixLastTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"}}}},"containsAllTermsInOrder":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"}}}},"withinPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"}}}},"intersectsPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"}}}},"in":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InQuery"}}}},"doesNotIntersectPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"}}}},"containsAllTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"}}}},"containsAnyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"}}}},"interval":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"}}}},"geoShapeV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"}}}},"startsWith":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Property"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyPropertyId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"},"type":{"type":"object","object":{"properties":{"minimumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maximumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappings":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappingsV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. An `interfaceToObjectTypeMappings` field is \noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\n\nThe `interfaceToObjectTypeMappings` field contains mappings from `SharedPropertyTypeApiName`s on the interface(s) to \n`PropertyApiName` for properties on the object(s).\n\nThe `interfaceToObjectTypeMappingsV2` field contains mappings from `InterfacePropertyApiName`s on the\ninterface(s) to `InterfacePropertyTypeImplementation` for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is\noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\nThe interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to\nPropertyApiName for properties on the object(s).\nThe interfaceToObjectTypeMappingsV2 field contains mappings from InterfacePropertyApiNames on the\ninterface(s) to InterfacePropertyTypeImplementation for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` \nmust be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either field or propertyIdentifier\nmust be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the struct parameter field.\n","plainTextDescription":"The unique identifier of the struct parameter field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds least of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds least of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"stringFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"}}}},"localizedFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.\n","plainTextDescription":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where at least one query is satisfied. An empty list matches no action types.","plainTextDescription":"Returns action types where at least one query is satisfied. An empty list matches no action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentMetadataResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"single":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}},"multiple":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The attachment metadata response","plainTextDescription":"The attachment metadata response","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"},"type":{"type":"object","object":{"properties":{"restrictedViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry restricted view.\n","plainTextDescription":"An object type datasource backed by a Foundry restricted view.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}},"filterLinkTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}}}},"safety":"SAFE","documentation":{"description":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.\n","plainTextDescription":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a direct-write source backing an object type.\n","plainTextDescription":"The RID of a direct-write source backing an object type.","example":["ri.ontology.main.direct-source.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the InterfacePropertyType.","plainTextDescription":"A short text that describes the InterfacePropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.\n","plainTextDescription":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"\n","plainTextDescription":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings required to access the property value. \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings required to access the property value.\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Performs both apply reducers and extract main value to return the reduced main value.","plainTextDescription":"Performs both apply reducers and extract main value to return the reduced main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"},"type":{"type":"object","object":{"properties":{"memberTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"},"type":{"type":"object","object":{"properties":{"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the main value of a struct as configured in the ontology.","plainTextDescription":"Returns the main value of a struct as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"},"type":{"type":"enum","enum":{"values":["PERCENTAGE","PER_MILLE","BASIS_POINTS"]}},"safety":"SAFE","documentation":{"description":"Ratio format options for displaying proportional values:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix\n","plainTextDescription":"Ratio format options for displaying proportional values:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"\n","plainTextDescription":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"","example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"\n","plainTextDescription":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"},"type":{"type":"object","object":{"properties":{"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\n`List object types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\nList object types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesV2Response"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponse"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the title property of an object type which is present on all object types.","plainTextDescription":"Specifies the title property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the sum of values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"},"type":{"type":"object","object":{"properties":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via the field of a local struct property.","plainTextDescription":"An implementation of an interface property via the field of a local struct property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSet"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"},"type":{"type":"enum","enum":{"values":["VALIDATE_ONLY","VALIDATE_AND_EXECUTE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `VALIDATE_AND_EXECUTE`.","plainTextDescription":"If not specified, defaults to VALIDATE_AND_EXECUTE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The current evaluation time itself. Carries no fields.","plainTextDescription":"The current evaluation time itself. Carries no fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"},"type":{"type":"object","object":{"properties":{"objects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Predefined localized formatting options.","plainTextDescription":"Predefined localized formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value.","plainTextDescription":"Returns objects where the specified field is greater than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"},"type":{"type":"object","object":{"properties":{"selectedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single link change between two objects.","plainTextDescription":"Represents a single link change between two objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series sync.","plainTextDescription":"The RID identifying a time series sync.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"}}}},"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"}}}},"editOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).\n","plainTextDescription":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"},"type":{"type":"enum","enum":{"values":["DAYS","HOURS","MINUTES","SECONDS","AUTO"]}},"safety":"SAFE","documentation":{"description":"Specifies the maximum precision to apply when formatting a duration.","plainTextDescription":"Specifies the maximum precision to apply when formatting a duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `oneOf` | The struct parameter field has a manually predefined set of options. |\n| `range` | The struct parameter field value must be within the defined range. |\n| `stringLength` | The struct parameter field value must have a length within the defined range. |\n| `stringRegexMatch` | The struct parameter field value must match a predefined regular expression. |\n| `objectQueryResult` | The struct parameter field value must be the primary key of an object found within an object set. |\n","plainTextDescription":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| oneOf | The struct parameter field has a manually predefined set of options. |\n| range | The struct parameter field value must be within the defined range. |\n| stringLength | The struct parameter field value must have a length within the defined range. |\n| stringRegexMatch | The struct parameter field value must match a predefined regular expression. |\n| objectQueryResult | The struct parameter field value must be the primary key of an object found within an object set. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified date or timestamp range.","plainTextDescription":"The parameter value must fall within the specified date or timestamp range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to local property).","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to local property).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"},"type":{"type":"object","object":{"properties":{"mainValueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The fields which comprise the main value of the struct.","plainTextDescription":"The fields which comprise the main value of the struct.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must have a length within the defined range.\n*This range is always inclusive.*\n","plainTextDescription":"The parameter value must have a length within the defined range.\nThis range is always inclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\n\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"},"type":{"type":"object","object":{"properties":{"linkId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}}}},"safety":"SAFE","documentation":{"description":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID. \nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.\n","plainTextDescription":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID.\nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Represents a unique identifier argument in a logic rule.","plainTextDescription":"Represents a unique identifier argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"}}}},"length":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"}}}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"}}}},"uuid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"}}}},"enum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"},"type":{"type":"enum","enum":{"values":["SECOND","MINUTE","HOUR","DAY","WEEK"]}},"safety":"SAFE","documentation":{"description":"Time unit for relative datetime offsets.","plainTextDescription":"Time unit for relative datetime offsets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains the provided value as a substring.","plainTextDescription":"Returns objects where the specified field contains the provided value as a substring.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property type that can be shared across object types.","plainTextDescription":"A property type that can be shared across object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'\n","plainTextDescription":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the primary key of an object found within an object set.\n","plainTextDescription":"The parameter value must be the primary key of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time range for a time series query.\n","plainTextDescription":"A relative time range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.\n","plainTextDescription":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which contain a logic rule of the given type.","plainTextDescription":"Returns action types which contain a logic rule of the given type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A user-specified alias for an aggregation metric name.","plainTextDescription":"A user-specified alias for an aggregation metric name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"},"type":{"type":"object","object":{"properties":{"entityType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object type or interface type API name.\n","plainTextDescription":"An object type or interface type API name.","example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts an object set to a specified object type or interface type API name. Any object whose object type does \nnot match the object type provided or implement the interface type provided will be dropped from the resulting \nobject set.\n","plainTextDescription":"Casts an object set to a specified object type or interface type API name. Any object whose object type does\nnot match the object type provided or implement the interface type provided will be dropped from the resulting\nobject set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on \nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRange"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The request to encrypt a plaintext value into a CipherText value.\n","plainTextDescription":"The request to encrypt a plaintext value into a CipherText value.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"definition":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The `definition` carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.\n","plainTextDescription":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The definition carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"},"type":{"type":"object","object":{"properties":{"conjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"disjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerConjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerDisjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"All marking requirements applicable to a property value.","plainTextDescription":"All marking requirements applicable to a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"},"type":{"type":"object","object":{"properties":{"ratioType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as a ratio with different scaling factors and suffixes:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")\n","plainTextDescription":"Display the value as a ratio with different scaling factors and suffixes:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"}}}},"createOrModifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"}}}},"batchedFunction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"}}}},"createOrModifyObjectV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"}}}},"deleteInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"}}}},"function":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}}},"createInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"}}}},"createInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A detailed operation for an Action","plainTextDescription":"A detailed operation for an Action","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have a notification.","plainTextDescription":"Returns action types based on whether they have a notification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in the following format.\n\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| [Attachment](/docs/foundry/api/v2/ontologies-v2-resources/attachment-properties/attachment-property-basics/) | JSON encoded `AttachmentProperty` object | `{\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"}` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` | \n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| Float | number | `3.14159265` |\n| GeoPoint | geojson | `{\"type\":\"Point\",\"coordinates\":[102.0,0.5]}` |\n| GeoShape | geojson | `{\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| [MediaReference](/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}}` |\n| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{\"value\": 10, \"propertySecurityIndex\" : 5}` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n| [Timeseries](/docs/foundry/api/v2/ontologies-v2-resources/time-series-properties/time-series-property-basics/) | JSON encoded `TimeseriesProperty` object or seriesId string | `{\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"}` or `{\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"}` or `\"wellPressureSeriesId\"`| |\n| Vector | array | `[0.1, 0.3, 0.02, 0.05 , 0.8, 0.4]` |\n\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.\n","plainTextDescription":"Represents the value of a property in the following format.\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | JSON encoded AttachmentProperty object | {\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"} |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| Float | number | 3.14159265 |\n| GeoPoint | geojson | {\"type\":\"Point\",\"coordinates\":[102.0,0.5]} |\n| GeoShape | geojson | {\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| MediaReference| JSON encoded MediaReference object | {\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}} |\n| Secured Property Value | JSON encoded SecuredPropertyValue object | {\"value\": 10, \"propertySecurityIndex\" : 5} |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |\n| Timeseries | JSON encoded TimeseriesProperty object or seriesId string | {\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"} or {\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"} or \"wellPressureSeriesId\"| |\n| Vector | array | [0.1, 0.3, 0.02, 0.05 , 0.8, 0.4] |\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"aggregate":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"searchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"}}}},"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"}}}},"intersect":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"}}}},"withProperties":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"}}}},"interfaceLinkSearchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"}}}},"nearestNeighbors":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"}}}},"asType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"}}}},"methodInput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"}}}},"filter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"}}}},"interfaceBase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"}}}},"asBaseObjectTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"}}}},"base":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the definition of an `ObjectSet` in the `Ontology`.","plainTextDescription":"Represents the definition of an ObjectSet in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"},"type":{"type":"object","object":{"properties":{"errors":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Arg"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"}}}},"removeLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"},"type":{"type":"object","object":{"properties":{"minimumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"applyReducersAndExtractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"}}}},"applyReducers":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"}}}},"extractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"}}}},"noLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The load level of the property:\n- APPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\n- EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\n- APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\n- NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.\n","plainTextDescription":"The load level of the property:\n\nAPPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\nEXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\nAPPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\nNO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"},"type":{"type":"object","object":{"properties":{"when":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.\n","plainTextDescription":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object parameter property argument in a logic rule.","plainTextDescription":"Represents an object parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The user's local timezone.","plainTextDescription":"The user's local timezone.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the interface type with the given rid.","plainTextDescription":"Returns action types which edit the interface type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.\n","plainTextDescription":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the link type with the given rid.","plainTextDescription":"Returns action types which edit the link type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"qos":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QosError"}}}},"success":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"},"type":{"type":"enum","enum":{"values":["EXPERIMENTAL","ACTIVE","DEPRECATED","EXAMPLE"]}},"safety":"SAFE","documentation":{"description":"Filter action types by status.","plainTextDescription":"Filter action types by status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Number of points in each window.","plainTextDescription":"Number of points in each window.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a column in a tabular datasource.","plainTextDescription":"The name of a column in a tabular datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Affix"},"type":{"type":"object","object":{"properties":{"prefix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"postfix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"An allowed configured value for a parameter within an action.","plainTextDescription":"An allowed configured value for a parameter within an action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.\n","plainTextDescription":"A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DecryptionResult"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value.","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Polygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Polygon"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatBasisPoints"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"\n","plainTextDescription":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the Geotime series.\n","plainTextDescription":"The set of properties that are bound to the Geotime series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.\n","plainTextDescription":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a static argument in a logic rule.","plainTextDescription":"Represents a static argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DataValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Attachment | string | `\"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` |\n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| EntrySet | array of JSON objects | `[{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}]` |\n| Float | number | `3.14159265` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| Marking | string | `\"MU\"` |\n| Null | null | `null` |\n| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z` |\n| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `\"EMP1234\"` |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| `{\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"}` |\n| Ontology Object Type Reference | string of the object type's api name | `\"Employee\"` |\n| Scenario Reference | string of the scenario RID | `\"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\"` |\n| Set | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object | `{\"name\": \"John Doe\", \"age\": 42}` |\n| TwoDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]}` |\n| ThreeDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]}` |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n","plainTextDescription":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | string | \"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\" |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| EntrySet | array of JSON objects | [{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}] |\n| Float | number | 3.14159265 |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| Marking | string | \"MU\" |\n| Null | null | null |\n| Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z |\n| Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or \"EMP1234\" |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| {\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"} |\n| Ontology Object Type Reference | string of the object type's api name | \"Employee\" |\n| Scenario Reference | string of the scenario RID | \"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\" |\n| Set | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object | {\"name\": \"John Doe\", \"age\": 42} |\n| TwoDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]} |\n| ThreeDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct list parameter field argument in a logic rule.","plainTextDescription":"Represents a struct list parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[".*fo?o*"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n - `.` matches any character.\n - `?` repeats the previous character 0 or 1 times.\n - `+` repeats the previous character 1 or more times.\n - `*` repeats the previous character 0 or more times.\n - `{}` defines the minimum and maximum number of times the preceding character can repeat. `{2}` means the\n previous character must repeat only twice, `{2,}` means the previous character must repeat at least twice,\n and `{2,4}` means the previous character must repeat between 2-4 times.\n - `|` is the OR operator.\n - `()` forms a group within an expression such that the group can be treated as a single character.\n - `[]` matches a single one of the characters contained inside the brackets, meaning [abc] matches `a`, `b` or\n `c`. Unless `-` is the first character or escaped with `\\` (in which case it is treated as a normal character),\n `-` can be used inside the bracket to create a range of characters, meaning [a-c] matches `a`, `b`, or `c`.\n If the character sequence inside the brackets begins with `^`, the set of characters is negated, meaning\n [^abc] does not match `a`, `b`, or `c`. Otherwise, `^` is treated as a normal character.\n - `\"` creates groups of string literals.\n - `\\` is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s \n and \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word \n characters respectively.\n\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n\n. matches any character.\n? repeats the previous character 0 or 1 times.\n+ repeats the previous character 1 or more times.\n* repeats the previous character 0 or more times.\n{} defines the minimum and maximum number of times the preceding character can repeat. {2} means the\nprevious character must repeat only twice, {2,} means the previous character must repeat at least twice,\nand {2,4} means the previous character must repeat between 2-4 times.\n| is the OR operator.\n() forms a group within an expression such that the group can be treated as a single character.\n[] matches a single one of the characters contained inside the brackets, meaning [abc] matches a, b or\nc. Unless - is the first character or escaped with \\ (in which case it is treated as a normal character),\n- can be used inside the bracket to create a range of characters, meaning [a-c] matches a, b, or c.\nIf the character sequence inside the brackets begins with ^, the set of characters is negated, meaning\n[^abc] does not match a, b, or c. Otherwise, ^ is treated as a normal character.\n\" creates groups of string literals.\n\\ is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s\nand \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word\ncharacters respectively.\n\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyVersion"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":["0000000d-2acf-537c-a228-3a9fe3cdc523"]}},{"locator":{"namespaceName":"Ontologies","localName":"QualifiedTimeseriesProperty"},"type":{"type":"object","object":{"properties":{"seriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"syncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by multiple time series syncs.","plainTextDescription":"The representation of a time series property backed by multiple time series syncs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}},"regex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","plainTextDescription":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Message returned when the value does not match the pattern.","plainTextDescription":"Message returned when the value does not match the pattern.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.\n","plainTextDescription":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"propertyMarkingSummary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"}}}},"unsupportedPolicy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"}}}},"errorComputingSecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.\n","plainTextDescription":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"},"type":{"type":"object","object":{"properties":{"datasetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Datasets","localName":"DatasetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry dataset.\n","plainTextDescription":"An object type datasource backed by a Foundry dataset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}},"scenarioRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"referenceSet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectLoadingResponseOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`branch` identifies the Foundry branch. `scenarioRid` identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, `branch` must identify that non-default base branch.\n","plainTextDescription":"branch identifies the Foundry branch. scenarioRid identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, branch must identify that non-default base branch.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the primary key value that is used as a unique identifier for an object.","plainTextDescription":"Represents the primary key value that is used as a unique identifier for an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}},"refresh":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"}}}},"updates":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Messages sent over the link type subscription WebSocket.","plainTextDescription":"Messages sent over the link type subscription WebSocket.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryOutputV2"},"type":{"type":"object","object":{"properties":{"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about the output of a query.","plainTextDescription":"Details about the output of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\n\nUse collectList or collectSet which will return a list of values in that case.\n","plainTextDescription":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\nUse collectList or collectSet which will return a list of values in that case.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A literal constraint value.","plainTextDescription":"A literal constraint value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A namespace for the type class.","plainTextDescription":"A namespace for the type class.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The value of the type class.","plainTextDescription":"The value of the type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Additional metadata that can be interpreted by user applications that interact with the Ontology\n","plainTextDescription":"Additional metadata that can be interpreted by user applications that interact with the Ontology","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.\n","plainTextDescription":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"},"type":{"type":"object","object":{"properties":{"signMediaReferences":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a `token` on each `MediaReference` value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\n\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.\n","plainTextDescription":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a token on each MediaReference value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Options for signing references in the response.","plainTextDescription":"Options for signing references in the response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field.","plainTextDescription":"Computes the approximate percentile value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deleteInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"}}}},"modifyInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"}}}},"createInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"},"type":{"type":"object","object":{"properties":{"regex":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The regular expression configured in the **Ontology Manager**.","plainTextDescription":"The regular expression configured in the Ontology Manager.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the **Ontology Manager**.\n","plainTextDescription":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must match a predefined regular expression.\n","plainTextDescription":"The parameter value must match a predefined regular expression.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given permission model.","plainTextDescription":"Returns action types with the given permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"},"type":{"type":"enum","enum":{"values":["START","END"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"entries":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","plainTextDescription":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a parameter ID argument in a logic rule.","plainTextDescription":"Represents a parameter ID argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"implementsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements.","plainTextDescription":"A list of interfaces that this object type implements.","example":[]}},"implementsInterfaces2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements and how it implements them.","plainTextDescription":"A list of interfaces that this object type implements and how it implements them.","example":[]}},"sharedPropertyTypeMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from shared property type API name to backing local property API name for the shared property types \npresent on this object type.\n","plainTextDescription":"A map from shared property type API name to backing local property API name for the shared property types\npresent on this object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"},"type":{"type":"object","object":{"properties":{"objectSetRidInputName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry restricted view.","plainTextDescription":"The RID of a Foundry restricted view.","example":["ri.foundry.main.restricted-view.8b2adf7c-ba8e-4d33-9bd7-46cc1c321ad4"]}},{"locator":{"namespaceName":"Ontologies","localName":"StringValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.\n","plainTextDescription":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsync","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RequestId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"Unique request id","plainTextDescription":"Unique request id","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenario"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"currentTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"}}}},"staticValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"}}}},"currentUser":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"}}}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"}}}},"interfaceParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"}}}},"synchronousWebhookOutput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"}}}},"objectParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"}}}},"uniqueIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.\n","plainTextDescription":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"},"type":{"type":"enum","enum":{"values":["STANDARD","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Currency rendering style options:\n- STANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\n- COMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")\n","plainTextDescription":"Currency rendering style options:\n\nSTANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\nCOMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value.","plainTextDescription":"Returns objects where the specified field is less than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Subtracts the right numeric value from the left numeric value.\n","plainTextDescription":"Subtracts the right numeric value from the left numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the `List interface types` endpoint and check the `allPropertiesV2` field or check\nthe **Ontology Manager**.\n","plainTextDescription":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the List interface types endpoint and check the allPropertiesV2 field or check\nthe Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QosError"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An error indicating that the subscribe request should be attempted on a different node.\n","plainTextDescription":"An error indicating that the subscribe request should be attempted on a different node.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"},"type":{"type":"object","object":{"properties":{"valueIfTrue":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is true","plainTextDescription":"Value to display if this boolean is true","example":[]}},"valueIfFalse":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is false","plainTextDescription":"Value to display if this boolean is false","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for boolean property values.","plainTextDescription":"Formatting configuration for boolean property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the object type with the given rid as an input or product.\n","plainTextDescription":"Returns action types which reference the object type with the given rid as an input or product.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.\n","plainTextDescription":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String or a double number.","plainTextDescription":"An object which is either an enum String or a double number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timestampFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"}}}},"operationIdsFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"description":"Map of the name of the derived property to return and its definition\n","plainTextDescription":"Map of the name of the derived property to return and its definition","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet which returns objects with additional derived properties.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which returns objects with additional derived properties.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"envelope":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}}},"geoJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.\n","plainTextDescription":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the object type.","plainTextDescription":"The API name of the object type.","example":["exampleAircraft"]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Ontology"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.\n","plainTextDescription":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series codex template that resolves to a derived series.","plainTextDescription":"The RID identifying a time series codex template that resolves to a derived series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns a single value of an array as configured in the ontology.","plainTextDescription":"Returns a single value of an array as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Calculates absolute value of a numeric value.\n","plainTextDescription":"Calculates absolute value of a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the object type with the given rid.","plainTextDescription":"Returns action types which edit the object type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides the left numeric value by the right numeric value.\n","plainTextDescription":"Divides the left numeric value by the right numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter expects an array of values and the size of the array must fall within the defined range.\n","plainTextDescription":"The parameter expects an array of values and the size of the array must fall within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"},"type":{"type":"object","object":{"properties":{"values":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".\n","plainTextDescription":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"},"type":{"type":"enum","enum":{"values":["ACTIVE","DEPRECATED"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given rid.","plainTextDescription":"Returns action types with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"TBD","plainTextDescription":"TBD","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"},"type":{"type":"enum","enum":{"values":["CEIL","FLOOR","ROUND_CLOSEST"]}},"safety":"SAFE","documentation":{"description":"Number rounding behavior:\n- CEIL: Always round up (3.1 becomes 4)\n- FLOOR: Always round down (3.9 becomes 3)\n- ROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)\n","plainTextDescription":"Number rounding behavior:\n\nCEIL: Always round up (3.1 becomes 4)\nFLOOR: Always round down (3.9 becomes 3)\nROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"alignmentTimestamp":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\n\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\n\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM, \neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.\n","plainTextDescription":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM,\neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.","example":[]}},"windowType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Aggregates values over discrete, periodic windows for a given time series.\n\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\n\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.\n","plainTextDescription":"Aggregates values over discrete, periodic windows for a given time series.\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.\n","plainTextDescription":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter must be omitted or empty.","plainTextDescription":"The parameter must be omitted or empty.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The response when loading entries from a geotemporal series reference property.\n\nEach entry in `data` is a map of property names to values containing the fields requested via\n`additionalProperties` in the corresponding `LoadGeotemporalSeriesRequest`. If `nextPageToken` is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.\n","plainTextDescription":"The response when loading entries from a geotemporal series reference property.\nEach entry in data is a map of property names to values containing the fields requested via\nadditionalProperties in the corresponding LoadGeotemporalSeriesRequest. If nextPageToken is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names that have been modified within the scenario.","plainTextDescription":"The list of link type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The link types that have been modified within a scenario.\n","plainTextDescription":"The link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditTypeFilter"},"type":{"type":"enum","enum":{"values":["create","modify","delete"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is in development.","plainTextDescription":"This status indicates that the PropertyType is in development.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"},"type":{"type":"enum","enum":{"values":["RUNNING_SUBMISSION_CHECKS","EXECUTING_WRITE_BACK_WEBHOOK","COMPUTING_ONTOLOGY_EDITS","COMPUTING_FUNCTION","WRITING_ONTOLOGY_EDITS","EXECUTING_SIDE_EFFECT_WEBHOOK","SENDING_NOTIFICATIONS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to \nspecify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, \nbut not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to\nspecify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,\nbut not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryRequest"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"filters":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sortOrder":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeAllPreviousProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of edits to return per page. Defaults to 100.","plainTextDescription":"The maximum number of edits to return per page. Defaults to 100.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request object for querying object type edits history, containing both filters and pagination parameters\n\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.\n","plainTextDescription":"Request object for querying object type edits history, containing both filters and pagination parameters\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"cause":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The subscription has been closed due to an irrecoverable error during its lifecycle.\n","plainTextDescription":"The subscription has been closed due to an irrecoverable error during its lifecycle.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface link type.","plainTextDescription":"The description of the interface link type.","example":[]}},"linkedEntityApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare at least one implementation of this link.\n","plainTextDescription":"Whether each implementing object type must declare at least one implementation of this link.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.\n","plainTextDescription":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface property type.","plainTextDescription":"The description of the interface property type.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypeRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface parameter property argument in a logic rule.","plainTextDescription":"Represents an interface parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinksResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of linked objects that have been edited within the scenario, grouped by source object.\n","plainTextDescription":"The list of linked objects that have been edited within the scenario, grouped by source object.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.\n","plainTextDescription":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the `List interface types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the List interface types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"now":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"}}}},"fixed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A datetime bound value.","plainTextDescription":"A datetime bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The ID identifying a transaction.","plainTextDescription":"The ID identifying a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via `PropertyWithLoadLevelSelector`) to opt a property out of a\n`defaultLoadLevel`.\n","plainTextDescription":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via PropertyWithLoadLevelSelector) to opt a property out of a\ndefaultLoadLevel.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.\n","plainTextDescription":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"auto":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"}}}},"off":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Fuzziness setting applied to `contains` full-text string predicates in the search query. If not provided,\n`auto` is used.\n","plainTextDescription":"Fuzziness setting applied to contains full-text string predicates in the search query. If not provided,\nauto is used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.\n","plainTextDescription":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.\n","plainTextDescription":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"},"type":{"type":"enum","enum":{"values":["newest_first","oldest_first"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"queryTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaMetadata"},"type":{"type":"object","object":{"properties":{"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Adds two or more numeric values.\n","plainTextDescription":"Adds two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}},"safety":"UNSAFE","documentation":{"example":[]}},"additionalProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.\n","plainTextDescription":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request body for loading entries from a geotemporal series reference property.\n\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as `OntologyObjectV2`.\n\nThe `range` field is required and restricts results to a specific time window. Both `startTime` and `endTime`\nare required on `range`. The `additionalProperties` field controls which additional properties appear in each\nreturned entry. Results are paginated; use `pageToken` from a previous response to retrieve additional pages.\n","plainTextDescription":"The request body for loading entries from a geotemporal series reference property.\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as OntologyObjectV2.\nThe range field is required and restricts results to a specific time window. Both startTime and endTime\nare required on range. The additionalProperties field controls which additional properties appear in each\nreturned entry. Results are paginated; use pageToken from a previous response to retrieve additional pages.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransaction"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Integer key for fixed value mapping.","plainTextDescription":"Integer key for fixed value mapping.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Query"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"By default, whenever an object is requested, all of its properties are returned, except for properties of the \nfollowing types:\n- Vector\n\nThe response can be filtered to only include certain properties using the `properties` query parameter. Note\nthat ontology object set endpoints refer to this parameter as `select`.\n\nProperties to include can be specified in one of two ways.\n\n- A comma delimited list as the value for the `properties` query parameter\n `properties={property1ApiName},{property2ApiName}`\n- Multiple `properties` query parameters.\n `properties={property1ApiName}&properties={property2ApiName}`\n\nThe primary key of the object will always be returned even if it wasn't specified in the `properties` values.\n\nUnknown properties specified in the `properties` list will result in a `PropertiesNotFound` error.\n\nTo find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"By default, whenever an object is requested, all of its properties are returned, except for properties of the\nfollowing types:\n\nVector\n\nThe response can be filtered to only include certain properties using the properties query parameter. Note\nthat ontology object set endpoints refer to this parameter as select.\nProperties to include can be specified in one of two ways.\n\nA comma delimited list as the value for the properties query parameter\nproperties={property1ApiName},{property2ApiName}\nMultiple properties query parameters.\nproperties={property1ApiName}&properties={property2ApiName}\n\nThe primary key of the object will always be returned even if it wasn't specified in the properties values.\nUnknown properties specified in the properties list will result in a PropertiesNotFound error.\nTo find the API name for your property, use the Get object type endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid RID (Resource Identifier).","plainTextDescription":"The string must be a valid RID (Resource Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"},"type":{"type":"object","object":{"properties":{"topLeft":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bottomRight":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The top left and bottom right coordinate points that make up the bounding box.\n","plainTextDescription":"The top left and bottom right coordinate points that make up the bounding box.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"},"type":{"type":"object","object":{"properties":{"operationIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"},"type":{"type":"object","object":{"properties":{"webhookOutputParamName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the webhook output parameter.","plainTextDescription":"The name of the webhook output parameter.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a synchronous webhook output argument in a logic rule.","plainTextDescription":"Represents a synchronous webhook output argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of \ntext fields. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of\ntext fields. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where every query is satisfied. An empty list matches all action types.","plainTextDescription":"Returns action types where every query is satisfied. An empty list matches all action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationObjectTypeGrouping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across \nmultiple object types, such as when aggregating over an interface type.\n","plainTextDescription":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across\nmultiple object types, such as when aggregating over an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"},"type":{"type":"enum","enum":{"values":["ASC","DESC"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"},"type":{"type":"object","object":{"properties":{"disjunction":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A disjunctive set of security results for a property value.\n","plainTextDescription":"A disjunctive set of security results for a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute datetime bound (ISO 8601 timestamp or date string).","plainTextDescription":"An absolute datetime bound (ISO 8601 timestamp or date string).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Indicates that the link types cannot be incrementally updated and must be refreshed.\n","plainTextDescription":"Indicates that the link types cannot be incrementally updated and must be refreshed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.\n","plainTextDescription":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"},"type":{"type":"enum","enum":{"values":["DAY","WEEK","MONTH","YEAR"]}},"safety":"SAFE","documentation":{"description":"Units for relative time calculations.","plainTextDescription":"Units for relative time calculations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"versionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must conform to the referenced value type.","plainTextDescription":"The parameter value must conform to the referenced value type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String, double number, or a geopoint.","plainTextDescription":"An object which is either an enum String, double number, or a geopoint.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.","plainTextDescription":"Divides objects into groups according to an exact value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"add":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"}}}},"absoluteValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"}}}},"extract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"}}}},"selection":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"}}}},"negate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"least":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"}}}},"divide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"}}}},"multiply":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"}}}},"greatest":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Definition of a derived property.\n","plainTextDescription":"Definition of a derived property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Duration"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"},"type":{"type":"object","object":{"properties":{"editedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Multiplies two or more numeric values.\n","plainTextDescription":"Multiplies two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"},"type":{"type":"object","object":{"properties":{"wrappedType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique id of a geotime series (track) associated with a GTSR.","plainTextDescription":"The unique id of a geotime series (track) associated with a GTSR.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `kind` attribute of a type class.","plainTextDescription":"Exact match predicate for the kind attribute of a type class.","example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `name` attribute of a type class.","plainTextDescription":"Exact match predicate for the name attribute of a type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching type classes. Matches a type class when `kind`, and `name` if provided, match the\ncorresponding attribute of the type class. If `name` is empty, only `kind` is required to match. You can\nsearch for both parameter type classes and action type type classes.\n","plainTextDescription":"A predicate for matching type classes. Matches a type class when kind, and name if provided, match the\ncorresponding attribute of the type class. If name is empty, only kind is required to match. You can\nsearch for both parameter type classes and action type type classes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names scoped by the object type.","plainTextDescription":"The list of link type API names scoped by the object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.\n","plainTextDescription":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Attachment"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation ranges.\n","plainTextDescription":"A union of all the types supported by query aggregation ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","plainTextDescription":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"The magnitude of a relative datetime offset.","plainTextDescription":"The magnitude of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsMultipleObjectTypes` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an ontology scenario.","plainTextDescription":"The unique resource identifier of an ontology scenario.","example":["ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"},"type":{"type":"object","object":{"properties":{"tableRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TableRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry table.","plainTextDescription":"An object type datasource backed by a Foundry table.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsRequest"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for staging edits to a transaction.","plainTextDescription":"The request payload for staging edits to a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Duration"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 formatted duration.","plainTextDescription":"An ISO 8601 formatted duration.","example":["PT15M"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"},"type":{"type":"object","object":{"properties":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"}}}},"datetime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"}}}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"}}}},"markdown":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"}}}},"mustBeEmpty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The allowed-values constraint configured on an action parameter.","plainTextDescription":"The allowed-values constraint configured on an action parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"},"type":{"type":"object","object":{"properties":{"implementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via applying reducers on the nested implementation.","plainTextDescription":"An implementation of an interface property via applying reducers on the nested implementation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"}}},"safety":"SAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"An override value to be used for a UniqueIdentifier action parameter, instead of \nthe value being automatically generated.\n","plainTextDescription":"An override value to be used for a UniqueIdentifier action parameter, instead of\nthe value being automatically generated.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided, \nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Reason"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.","plainTextDescription":"Divides objects into groups with the specified width.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioConflictingObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have a conflicting edit within the scenario.","plainTextDescription":"The list of objects that have a conflicting edit within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have a conflicting edit within a scenario for a given object type.","plainTextDescription":"The objects that have a conflicting edit within a scenario for a given object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Affix"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"\n","plainTextDescription":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"webhookRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"}}}},"hasActionLog":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"}}}},"actionTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"}}}},"permissionModel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"}}}},"hasWebhook":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"}}}},"actionTypeDisplayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"}}}},"affectedLinkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"}}}},"actionTypeDescription":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"}}}},"sectionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"}}}},"parameterRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"}}}},"parameterName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"}}}},"hasNotification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"}}}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"}}}},"inputObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"}}}},"revertActionEnabled":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"}}}},"logicRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"}}}},"typeClasses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"}}}},"affectedInterfaceTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"}}}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"}}}},"affectedObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"}}}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the search query for an action type search. Supports filters for various action type features.\n","plainTextDescription":"Represents the search query for an action type search. Supports filters for various action type features.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the average value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"},"type":{"type":"enum","enum":{"values":["BEFORE","AFTER"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a struct parameter's fields against the configured constraints.","plainTextDescription":"Represents the validity of a struct parameter's fields against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.","plainTextDescription":"Divides objects into groups according to specified ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"},"type":{"type":"object","object":{"properties":{"unionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.\n","plainTextDescription":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"interfaceDefinedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"}}}},"interfaceSharedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.\n","plainTextDescription":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"toolDescription":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Optional description intended for tool use contexts, such as AI agents.","plainTextDescription":"Optional description intended for tool use contexts, such as AI agents.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end date.","plainTextDescription":"Exclusive end date.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive end date.","plainTextDescription":"Inclusive end date.","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive start date.","plainTextDescription":"Exclusive start date.","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start date.","plainTextDescription":"Inclusive start date.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a date range from an inclusive start date to an exclusive end date.","plainTextDescription":"Specifies a date range from an inclusive start date to an exclusive end date.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"pluralDisplayName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The plural display name of the object type.","plainTextDescription":"The plural display name of the object type.","example":[]}},"icon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Icon"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"aliases":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. `getObjectTypeV2`); it is always empty on the `listObjectTypesV2` endpoint.\n","plainTextDescription":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. getObjectTypeV2); it is always empty on the listObjectTypesV2 endpoint.","example":[]}},"datasources":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"}}}}},"safety":"UNSAFE","documentation":{"description":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies `includeDatasources=true`. This list may be empty if the user doesn't have access to any\ndatasources.\n","plainTextDescription":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies includeDatasources=true. This list may be empty if the user doesn't have access to any\ndatasources.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"description":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\n\nEach object type's `linkTypes` is only populated when the request specifies\n`includeLinkTypes=true`, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.\n","plainTextDescription":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\nEach object type's linkTypes is only populated when the request specifies\nincludeLinkTypes=true, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectSetChanged":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"}}}},"refreshObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"}}}},"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"},"type":{"type":"object","object":{"properties":{"includesAllPreviousValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.\n","plainTextDescription":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"geometry":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"}}},"safety":"UNSAFE","documentation":{"example":[]}},"spatialFilterMode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager**\napplication.\n","plainTextDescription":"The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager\napplication.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given status.","plainTextDescription":"Returns action types with the given status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an attachment.","plainTextDescription":"The unique resource identifier of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"},"type":{"type":"object","object":{"properties":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the `fields` array is provided, `orderType` is automatically set to `fields`.\nIf this object is omitted entirely, the ordering is unspecified.\n\nSetting `orderType` to `relevance` requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. `containsAllTerms`, `containsAnyTerm`,\n`containsAllTermsInOrder`, `containsAllTermsInOrderPrefixLastTerm`) or `nearestNeighbors`, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\n\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\n\nRelevance ordering can be expensive and should only be used when required.\n","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the fields array is provided, orderType is automatically set to fields.\nIf this object is omitted entirely, the ordering is unspecified.\nSetting orderType to relevance requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. containsAllTerms, containsAnyTerm,\ncontainsAllTermsInOrder, containsAllTermsInOrderPrefixLastTerm) or nearestNeighbors, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\nRelevance ordering can be expensive and should only be used when required.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"},"type":{"type":"object","object":{"properties":{"showFullUnits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to show full or abbreviated time units.","plainTextDescription":"Whether to show full or abbreviated time units.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formats the duration as a human-readable written string.","plainTextDescription":"Formats the duration as a human-readable written string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"},"type":{"type":"object","object":{"properties":{"zoneId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"},"type":{"type":"enum","enum":{"values":["fields","relevance"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"}}}},"get":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"}}}},"collectList":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"}}}},"collectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property\n","plainTextDescription":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"},"type":{"type":"object","object":{"properties":{"defaultValidation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation metadata surfaced for a parameter.","plainTextDescription":"Validation metadata surfaced for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from the backing column struct field names to a struct property's fields.\n","plainTextDescription":"A mapping from the backing column struct field names to a struct property's fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the maximum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for date property values.","plainTextDescription":"Formatting configuration for date property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a display name matching the given string predicate.","plainTextDescription":"Returns action types with a display name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"},"type":{"type":"enum","enum":{"values":["SUM","MEAN","STANDARD_DEVIATION","MAX","MIN","PERCENT_CHANGE","DIFFERENCE","PRODUCT","COUNT","FIRST","LAST"]}},"safety":"SAFE","documentation":{"description":"The aggregation function to use for aggregating time series data.\n","plainTextDescription":"The aggregation function to use for aggregating time series data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to specified ranges.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyObjectTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","plainTextDescription":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Property"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"},"type":{"type":"object","object":{"properties":{"term":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The term to match.","plainTextDescription":"The term to match.","example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.\n","plainTextDescription":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.\n","plainTextDescription":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioResponse"},"type":{"type":"object","object":{"properties":{"scenarioRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The response payload for creating an ontology scenario.","plainTextDescription":"The response payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}}},"pointsCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\n\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.\n","plainTextDescription":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"},"type":{"type":"object","object":{"properties":{"typeId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to a type that is defined in the `typeReferences` map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.\n","plainTextDescription":"A reference to a type that is defined in the typeReferences map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"},"type":{"type":"object","object":{"properties":{"uniqueIdentifierLinkIdValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"}}}}},"safety":"SAFE","documentation":{"example":[]}},"actionExecutionTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"},"type":{"type":"object","object":{"properties":{"scaleType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n- THOUSANDS: 1500 displays as \"1.5K\"\n- MILLIONS: 2500000 displays as \"2.5M\"\n- BILLIONS: 3200000000 displays as \"3.2B\"\n","plainTextDescription":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n\nTHOUSANDS: 1500 displays as \"1.5K\"\nMILLIONS: 2500000 displays as \"2.5M\"\nBILLIONS: 3200000000 displays as \"3.2B\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings representing the same sequence of characters as the given string.","plainTextDescription":"Matches strings representing the same sequence of characters as the given string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"},"type":{"type":"enum","enum":{"values":["actionTypeDisplayName"]}},"safety":"SAFE","documentation":{"description":"Specifies the field to sort action types by.","plainTextDescription":"Specifies the field to sort action types by.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"},"type":{"type":"object","object":{"properties":{"maxSizeBytes":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","plainTextDescription":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property filter. For instance, false is the FilterValue in\n`properties.{propertyApiName}.isNull=false`.\n","plainTextDescription":"Represents the value of a property filter. For instance, false is the FilterValue in\nproperties.{propertyApiName}.isNull=false.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkState"},"type":{"type":"enum","enum":{"values":["ADDED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.\n","plainTextDescription":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"request":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsOrInterfaces` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingInterfaceLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface link types in the current page.","plainTextDescription":"The list of interface link types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"},"type":{"type":"enum","enum":{"values":["INTERSECTS","DISJOINT","WITHIN","CONTAINS"]}},"safety":"SAFE","documentation":{"description":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.\n","plainTextDescription":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"},"type":{"type":"object","object":{"properties":{"geoJson":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.\n","plainTextDescription":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry specification.","plainTextDescription":"A GeoJSON geometry specification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version of the given Function, written `..-`, where `-` is optional.\nExamples: `1.2.3`, `1.2.3-rc1`.\n","plainTextDescription":"The version of the given Function, written ..-, where - is optional.\nExamples: 1.2.3, 1.2.3-rc1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.\n","plainTextDescription":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"relativePoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a bound for a relative date range query.","plainTextDescription":"Specifies a bound for a relative date range query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a parameter matching the given parameter rid.","plainTextDescription":"Returns action types with a parameter matching the given parameter rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the primary key property of an object type which is present on all object types.","plainTextDescription":"Specifies the primary key property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"}}}},"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked entity. This can either be an object or an interface type.","plainTextDescription":"A reference to the linked entity. This can either be an object or an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Definition for a selected property over a MethodObjectSet.","plainTextDescription":"Definition for a selected property over a MethodObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of directed link type API names.","plainTextDescription":"A list of directed link type API names.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the **Ontology Manager**.\n","plainTextDescription":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface.","plainTextDescription":"The description of the interface.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"allProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has, including properties from all directly and indirectly extended \ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has, including properties from all directly and indirectly extended\ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.","example":[]}},"allPropertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.","example":[]}},"extendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n","plainTextDescription":"A list of interface API names that this interface extends. An interface can extend other interfaces to\ninherit their properties.","example":[]}},"allExtendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends, both directly and indirectly.\n","plainTextDescription":"A list of interface API names that this interface extends, both directly and indirectly.","example":[]}},"implementedByObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object API names that implement this interface.\n","plainTextDescription":"A list of object API names that implement this interface.","example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.","example":[]}},"allLinks":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface type in the Ontology.","plainTextDescription":"Represents an interface type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier for an action.","plainTextDescription":"The unique resource identifier for an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"},"type":{"type":"enum","enum":{"values":["ADD_OBJECT","MODIFY_OBJECT","DELETE_OBJECT","ADD_LINK","DELETE_LINK","FUNCTION","BATCHED_FUNCTION","ADD_OR_MODIFY_OBJECT","ADD_OR_MODIFY_OBJECT_V2"]}},"safety":"SAFE","documentation":{"description":"Filter action types by the type of logic rule they contain.","plainTextDescription":"Filter action types by the type of logic rule they contain.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterface"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"deadline":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"example":[]}},"replacedBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.\n","plainTextDescription":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a link type. To find the ID for your link type, check the **Ontology Manager** application.\n","plainTextDescription":"The unique ID of a link type. To find the ID for your link type, check the Ontology Manager application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the \n[Ontology Manager](/docs/foundry/ontology-manager/overview/).\n","plainTextDescription":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the\nOntology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"},"type":{"type":"object","object":{"properties":{"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating one of the **submission criteria** was not satisfied.\nThis is configured per **submission criteria** in the **Ontology Manager**.\n","plainTextDescription":"The message indicating one of the submission criteria was not satisfied.\nThis is configured per submission criteria in the Ontology Manager.","example":[]}},"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Contains the status of the **submission criteria**.\n**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the **Ontology Manager**.\n","plainTextDescription":"Contains the status of the submission criteria.\nSubmission criteria are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherTextProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"part":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts the specified date part from a date or timestamp.\n","plainTextDescription":"Extracts the specified date part from a date or timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"dateValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DateValue"}}}},"stringValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringValue"}}}},"timestampValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"}}}},"booleanValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"}}}},"integerValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"}}}},"doubleValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"}}}},"longValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LongValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property api name that references properties to query on.","plainTextDescription":"A property api name that references properties to query on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have an action log.","plainTextDescription":"Returns action types based on whether they have an action log.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"geopoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoPointType"}}}},"geotimeSeriesReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeotimeSeriesReferenceType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"timeseries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimeseriesType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Object properties.\n","plainTextDescription":"A union of all the types supported by Ontology Object properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Formats the duration in a timecode format.","plainTextDescription":"Formats the duration in a timecode format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operationId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The user ID or principal that performed the action","plainTextDescription":"The user ID or principal that performed the action","example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"When this edit occurred (ISO 8601 format)","plainTextDescription":"When this edit occurred (ISO 8601 format)","example":[]}},"edit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.\n","plainTextDescription":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action.","plainTextDescription":"Details about a parameter of an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesFullMetadataResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamingOutputFormat"},"type":{"type":"enum","enum":{"values":["JSON","ARROW"]}},"safety":"SAFE","documentation":{"description":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.\n","plainTextDescription":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsForInterfaceResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface instances in the current page.","plainTextDescription":"The list of interface instances in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The source of a constraint bound value.","plainTextDescription":"The source of a constraint bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"optional":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API.\n","plainTextDescription":"The name of the Query in the API.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueType"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. |\n| Attachment | `Attachment` |\n| Boolean | `Boolean` |\n| Byte | `Byte` |\n| CipherText | `CipherText` |\n| Date | `LocalDate` |\n| Decimal | `Decimal` |\n| Double | `Double` |\n| Float | `Float` |\n| Integer | `Integer` |\n| Long | `Long` |\n| Marking | `Marking` |\n| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. |\n| Short | `Short` |\n| String | `String` |\n| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` |\n| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. |\n| Timestamp | `Timestamp` |\n","plainTextDescription":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | Array, where T is the type of the array elements, e.g. Array. |\n| Attachment | Attachment |\n| Boolean | Boolean |\n| Byte | Byte |\n| CipherText | CipherText |\n| Date | LocalDate |\n| Decimal | Decimal |\n| Double | Double |\n| Float | Float |\n| Integer | Integer |\n| Long | Long |\n| Marking | Marking |\n| OntologyObject | OntologyObject where T is the API name of the referenced object type. |\n| Short | Short |\n| String | String |\n| Struct | Struct where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> |\n| Timeseries | TimeSeries where T is either String for an enum series or Double for a numeric series. |\n| Timestamp | Timestamp |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"},"type":{"type":"object","object":{"properties":{"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"KnownType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formatting configuration for known Foundry types.","plainTextDescription":"Formatting configuration for known Foundry types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked interface type.","plainTextDescription":"A reference to the linked interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Error"},"type":{"type":"object","object":{"properties":{"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"}}},"safety":"SAFE","documentation":{"example":[]}},"args":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Arg"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry stream.","plainTextDescription":"The RID of a Foundry stream.","example":["ri.foundry.main.stream.f7e91c94-1cb2-4e34-8fdb-3da7c1a91e8b"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.\n","plainTextDescription":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"rid","rid":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current user argument in a logic rule.","plainTextDescription":"Represents the current user argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CustomTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A UUID representing a custom type in a given Function.\n","plainTextDescription":"A UUID representing a custom type in a given Function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a description matching the given string predicate.","plainTextDescription":"Returns action types with a description matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedEntityTypesResponse"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of edited link types grouped by source object type.\n\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.\n","plainTextDescription":"The list of edited link types grouped by source object type.\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types and link types that have been modified within a scenario.\n","plainTextDescription":"The object types and link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedTimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"templateRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"}}},"safety":"SAFE","documentation":{"example":[]}},"templateVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by a derived time series calculated with a formula.","plainTextDescription":"The representation of a time series property backed by a derived time series calculated with a formula.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS","QUARTERS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"constraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.\n","plainTextDescription":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a property.","plainTextDescription":"The unique resource identifier of a property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"partialMatch":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a classification or mandatory marking.","plainTextDescription":"The id of a classification or mandatory marking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which use the function with the given rid.","plainTextDescription":"Returns action types which use the function with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequest"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"query":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationV2"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsyncV2","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field.","plainTextDescription":"Returns objects based on the existence of the specified field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"}}}},"number":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"}}}},"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces. \nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\n\nEach formatter type provides specific options tailored to that data type:\n- Numbers: Support for percentages, currencies, units, scaling, and custom formatting\n- Dates/Timestamps: Localized and custom formatting patterns\n- Booleans: Custom true/false display text\n- Known types: Special formatting for Foundry-specific identifiers\n","plainTextDescription":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces.\nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\nEach formatter type provides specific options tailored to that data type:\n\nNumbers: Support for percentages, currencies, units, scaling, and custom formatting\nDates/Timestamps: Localized and custom formatting patterns\nBooleans: Custom true/false display text\nKnown types: Special formatting for Foundry-specific identifiers","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched terms must occur in order.","plainTextDescription":"If true, the matched terms must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing the terms in the query\n","plainTextDescription":"Matches intervals containing the terms in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"},"type":{"type":"enum","enum":{"values":["DATASOURCE_DERIVED_PERMISSIONS","ONTOLOGY_ROLES","COMPASS_PROJECT"]}},"safety":"SAFE","documentation":{"description":"Filter action types by permission model.","plainTextDescription":"Filter action types by permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaReferenceProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter.","plainTextDescription":"A possible value for the parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DateValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"date","date":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in string format. This is used in URL parameters.","plainTextDescription":"Represents the value of a property in string format. This is used in URL parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"},"type":{"type":"enum","enum":{"values":["USER_CLOSED","CHANNEL_CLOSED"]}},"safety":"SAFE","documentation":{"description":"Represents the reason a subscription was closed.\n","plainTextDescription":"Represents the reason a subscription was closed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the server was not able to load the securities of the property.","plainTextDescription":"Indicates the server was not able to load the securities of the property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current Page.","plainTextDescription":"The list of objects in the current Page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`.","plainTextDescription":"Represents the API response when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"constant":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"}}}},"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentProperty"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The representation of an attachment as a data type.","plainTextDescription":"The representation of an attachment as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager**\napplication and assign them API names. In every other case, API names should be used instead of property IDs.\n","plainTextDescription":"The immutable ID of a property. Property IDs are only used to identify properties in the Ontology Manager\napplication and assign them API names. In every other case, API names should be used instead of property IDs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The base used to initialize a scenario.","plainTextDescription":"The base used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"any":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AnyType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the primitive types used by Palantir's Ontology-based products.\n","plainTextDescription":"A union of all the primitive types used by Palantir's Ontology-based products.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"}}}}},"safety":"UNSAFE","documentation":{"description":"List of historical edits for this object type","plainTextDescription":"List of historical edits for this object type","example":[]}},"totalCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Count of items in the data array above","plainTextDescription":"Count of items in the data array above","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.\n","plainTextDescription":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"},"type":{"type":"object","object":{"properties":{"color":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A hexadecimal color code.","plainTextDescription":"A hexadecimal color code.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. \nUsed to specify the Blueprint icon to represent the object type in a React app.\n","plainTextDescription":"The name of the Blueprint icon.\nUsed to specify the Blueprint icon to represent the object type in a React app.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"reducers":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"}}}}},"safety":"UNSAFE","documentation":{"description":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.\n","plainTextDescription":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the struct type to the value type applied to that property.","plainTextDescription":"A map of the properties of the struct type to the value type applied to that property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A valid format string composed of date/time patterns.","plainTextDescription":"A valid format string composed of date/time patterns.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A strictly specified date format pattern.","plainTextDescription":"A strictly specified date format pattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"transactionId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"absolute":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute or relative range for a time series query.","plainTextDescription":"An absolute or relative range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"},"type":{"type":"object","object":{"properties":{"mapping":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be a property value of an object found within an object set.\n","plainTextDescription":"The parameter value must be a property value of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LongValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.\n","plainTextDescription":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"},"type":{"type":"object","object":{"properties":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A branch reference used to initialize a scenario.","plainTextDescription":"A branch reference used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"description":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.\n","plainTextDescription":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["fo*o"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the wildcard pattern provided.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the wildcard pattern provided.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Action"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"standard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"}}}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"}}}},"fixedValues":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"}}}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"}}}},"scale":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"}}}},"currency":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"}}}},"standardUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"}}}},"customUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"}}}},"ratio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToDelete":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}},"includeLinkTypes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all outgoing link types for each requested object type in that object type's\n`linkTypes`. When false or omitted, `linkTypes` is empty.\n","plainTextDescription":"A flag that will return all outgoing link types for each requested object type in that object type's\nlinkTypes. When false or omitted, linkTypes is empty.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"},"type":{"type":"object","object":{"properties":{"interfaceType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object set with objects that implement the interface with the given interface API name. The objects in \nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.\n","plainTextDescription":"An object set with objects that implement the interface with the given interface API name. The objects in\nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.","example":[]}},"includeAllBaseObjectProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all of the underlying object properties for the objects that implement the interface. \nThis includes properties that don't explicitly implement an SPT on the interface.\n","plainTextDescription":"A flag that will return all of the underlying object properties for the objects that implement the interface.\nThis includes properties that don't explicitly implement an SPT on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"},"type":{"type":"enum","enum":{"values":["ADDED_OR_UPDATED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was \nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object \nwas removed from the set due to the object being deleted or the object no longer meets the object set \ndefinition.\n","plainTextDescription":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was\nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object\nwas removed from the set due to the object being deleted or the object no longer meets the object set\ndefinition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"},"type":{"type":"object","object":{"properties":{"direction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"}}},"safety":"SAFE","documentation":{"example":[]}},"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a geotime integration.","plainTextDescription":"The unique resource identifier of a geotime integration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SecuredPropertyValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertySecurityIndex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.\n","plainTextDescription":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationOrderBy"},"type":{"type":"object","object":{"properties":{"metricName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds greatest of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds greatest of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.\n","plainTextDescription":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"geotimeSeriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a geotime series integration as a data type.","plainTextDescription":"The representation of a geotime series integration as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name or RID of the Ontology. To find the API name or RID, use the **List Ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or\ncheck the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"},"type":{"type":"enum","enum":{"values":["REQUIRE_ACCURATE","ALLOW_APPROXIMATE"]}},"safety":"SAFE","documentation":{"description":"Specifies the accuracy requirement for aggregation results.\n\n- `REQUIRE_ACCURATE`: Only return results if they are guaranteed to be accurate. If accuracy cannot be\n guaranteed (e.g., due to a low `maxGroupCount` relative to distinct values), the request will fail\n with an `AggregationAccuracyNotSupported` error.\n- `ALLOW_APPROXIMATE`: Allow approximate results when exact computation is not feasible. This is the\n default behavior if not specified.\n","plainTextDescription":"Specifies the accuracy requirement for aggregation results.\n\nREQUIRE_ACCURATE: Only return results if they are guaranteed to be accurate. If accuracy cannot be\nguaranteed (e.g., due to a low maxGroupCount relative to distinct values), the request will fail\nwith an AggregationAccuracyNotSupported error.\nALLOW_APPROXIMATE: Allow approximate results when exact computation is not feasible. This is the\ndefault behavior if not specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value.","plainTextDescription":"Returns objects where the specified field is less than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"},"type":{"type":"object","object":{"properties":{"ciphertext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CipherText"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.","example":[{"ciphertext":"CIPHER::ri.bellaso.main.cipher-channel.x::::CIPHER"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the `typeReferences` map of the enclosing Query.\n","plainTextDescription":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the typeReferences map of the enclosing Query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"},"type":{"type":"object","object":{"properties":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the media view.\n","plainTextDescription":"The set of properties that are bound to the media view.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.\n","plainTextDescription":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"},"type":{"type":"object","object":{"properties":{"sourceObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsForInterfaceRequest"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"augmentedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from object type API name to a list of property type API names. For each returned object, if the \nobject’s object type is a key in the map, then we augment the response for that object type with the list \nof properties specified in the value.\n","plainTextDescription":"A map from object type API name to a list of property type API names. For each returned object, if the\nobject’s object type is a key in the map, then we augment the response for that object type with the list\nof properties specified in the value.","example":[]}},"augmentedSharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"augmentedInterfacePropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of interface property type API names. For each returned object, \nif the object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of interface property type API names. For each returned object,\nif the object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"selectedSharedPropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of shared property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of shared property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedInterfacePropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of interface property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the \nparameter to include all object types.\n","plainTextDescription":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the\nparameter to include all object types.","example":[]}},"otherInterfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be \nincluded in the response.\n","plainTextDescription":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be\nincluded in the response.","example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"},"type":{"type":"enum","enum":{"values":["VALID","INVALID"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a validation.\n","plainTextDescription":"Represents the state of a validation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"},"type":{"type":"object","object":{"properties":{"targetObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe `targetObject` Ontology Object in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe targetObject Ontology Object in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"KnownType"},"type":{"type":"enum","enum":{"values":["USER_OR_GROUP_ID","RESOURCE_RID","ARTIFACT_GID"]}},"safety":"SAFE","documentation":{"description":"Known Foundry types for specialized formatting:\n- userOrGroupRid: Format as user or group\n- resourceRid: Format as resource \n- artifactGid: Format as artifact\n","plainTextDescription":"Known Foundry types for specialized formatting:\n\nuserOrGroupRid: Format as user or group\nresourceRid: Format as resource\nartifactGid: Format as artifact","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they reference a webhook.","plainTextDescription":"Returns action types based on whether they reference a webhook.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"},"type":{"type":"object","object":{"properties":{"method":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"}}},"safety":"SAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct parameter field argument in a logic rule.","plainTextDescription":"Represents a struct parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"},"type":{"type":"object","object":{"properties":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionInputValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"}}}}},"safety":"UNSAFE","documentation":{"description":"The predefined set of options.","plainTextDescription":"The predefined set of options.","example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether values outside `options` are allowed.","plainTextDescription":"Whether values outside options are allowed.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be one of a fixed set of labelled options.","plainTextDescription":"The parameter value must be one of a fixed set of labelled options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo"]}}}}},"safety":"UNSAFE","documentation":{"description":"Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`, which is preferred because the name `startsWith` is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via a local property.","plainTextDescription":"An implementation of an interface property via a local property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"link":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of groups to return. If omitted, defaults to 10,000.\n\nThe server allocates resources based on the specified `maxGroupCount`. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\n\nIf you need accurate results with high-cardinality properties, set `maxGroupCount` high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\n`excludedItems`. The response `accuracy` field indicates whether the results are `ACCURATE` or\n`APPROXIMATE`.\n","plainTextDescription":"The maximum number of groups to return. If omitted, defaults to 10,000.\nThe server allocates resources based on the specified maxGroupCount. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\nIf you need accurate results with high-cardinality properties, set maxGroupCount high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\nexcludedItems. The response accuracy field indicates whether the results are ACCURATE or\nAPPROXIMATE.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.\n","plainTextDescription":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.","example":[]}},"includeNullValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.\n","plainTextDescription":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an exact value.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"},"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"An ISO 8601 timestamp.\n","plainTextDescription":"An ISO 8601 timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value.","plainTextDescription":"Returns objects where the specified array contains a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"ObjectSet which is the root of a MethodObjectSet definition.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which is the root of a MethodObjectSet definition.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter` of type\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter of type\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types whose type class satisfies the given type class predicate.","plainTextDescription":"Returns action types whose type class satisfies the given type class predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"},"type":{"type":"object","object":{"properties":{"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property API name and the load level to apply to the property. You can select a reduced value\nfor arrays and the main value for structs. If the provided load level cannot be applied to the property type,\nthen it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property API name and the load level to apply to the property. You can select a reduced value\nfor arrays and the main value for structs. If the provided load level cannot be applied to the property type,\nthen it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique codex id of a time series.","plainTextDescription":"The unique codex id of a time series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deprecated":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"}}}},"active":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"}}}},"experimental":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"}}}},"example":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.\n","plainTextDescription":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}},"reducedPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property.\n","plainTextDescription":"Describes how an object type implements an interface property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"\n","plainTextDescription":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The duration value.","plainTextDescription":"The duration value.","example":[30]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A measurement of duration.","plainTextDescription":"A measurement of duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"},"type":{"type":"enum","enum":{"values":["THOUSANDS","MILLIONS","BILLIONS"]}},"safety":"SAFE","documentation":{"description":"Scale factor options for large numbers:\n- THOUSANDS: Divide by 1,000 and add \"K\" suffix\n- MILLIONS: Divide by 1,000,000 and add \"M\" suffix\n- BILLIONS: Divide by 1,000,000,000 and add \"B\" suffix\n","plainTextDescription":"Scale factor options for large numbers:\n\nTHOUSANDS: Divide by 1,000 and add \"K\" suffix\nMILLIONS: Divide by 1,000,000 and add \"M\" suffix\nBILLIONS: Divide by 1,000,000,000 and add \"B\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A unique identifier used to associate subscription requests with responses.","plainTextDescription":"A unique identifier used to associate subscription requests with responses.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"createEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"}}}},"deleteEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"}}}},"modifyEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching strings.","plainTextDescription":"A predicate for matching strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"},"type":{"type":"object","object":{"properties":{"allowedValues":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"arraySize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation constraints for a parameter.","plainTextDescription":"Validation constraints for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a section matching the given section rid.","plainTextDescription":"Returns action types with a section matching the given section rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"},"type":{"type":"object","object":{"properties":{"unsupportedType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A short, stable discriminator naming the underlying OMS variant. E.g., `\"derivedProperties\"` for\nderived-properties datasources or `\"unknown\"` for variants the adapter does not recognize.\n","plainTextDescription":"A short, stable discriminator naming the underlying OMS variant. E.g., \"derivedProperties\" for\nderived-properties datasources or \"unknown\" for variants the adapter does not recognize.","example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The property API names that this datasource backs.","plainTextDescription":"The property API names that this datasource backs.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource of a kind not yet exposed in the public API. The `unsupportedType` discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an `\"unknown\"` discriminator. The `properties` list\nenumerates the property API names this datasource backs. The `properties` will be empty for `\"unknown\"`\ndatasources.\n","plainTextDescription":"A datasource of a kind not yet exposed in the public API. The unsupportedType discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an \"unknown\" discriminator. The properties list\nenumerates the property API names this datasource backs. The properties will be empty for \"unknown\"\ndatasources.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"},"type":{"type":"enum","enum":{"values":["FUTURE","PAST"]}},"safety":"SAFE","documentation":{"description":"Direction of a relative datetime offset.","plainTextDescription":"Direction of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structListParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"}}}},"structParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument used for an individual struct field.\n","plainTextDescription":"Represents an argument used for an individual struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by `p` or `properties`. The format expected format is\n`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...`\n\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending \n`:asc` (for ascending) or `:desc` (for descending).\n\nExample: use `orderBy=properties.lastName:asc` to order by a single property, \n`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. \nYou may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`.\n","plainTextDescription":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by p or properties. The format expected format is\norderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending\n:asc (for ascending) or :desc (for descending).\nExample: use orderBy=properties.lastName:asc to order by a single property,\norderBy=properties.lastName,properties.firstName,properties.age:desc to order by multiple properties.\nYou may also use the shorthand p instead of properties such as orderBy=p.lastName:asc.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.\n","plainTextDescription":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.","example":["master"]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \nAll markings from a conjunctive set must be met for access.\n\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\n\nAll markings from a conjunctive set must be met for access.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of a query.","plainTextDescription":"Details about a parameter of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fullLogicRules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns the full metadata for an Action type in the Ontology.","plainTextDescription":"Returns the full metadata for an Action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction.","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"},"type":{"type":"object","object":{"properties":{"useGrouping":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","plainTextDescription":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","example":[]}},"convertNegativeToParenthesis":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, wrap negative numbers in parentheses instead of a minus sign.","plainTextDescription":"If true, wrap negative numbers in parentheses instead of a minus sign.","example":[]}},"minimumIntegerDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"notation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"roundingMode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\n\nExamples:\n- useGrouping: true makes 1234567 display as \"1,234,567\"\n- maximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\n- notation: SCIENTIFIC makes 1234 display as \"1.234E3\"\n","plainTextDescription":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\nExamples:\n\nuseGrouping: true makes 1234567 display as \"1,234,567\"\nmaximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\nnotation: SCIENTIFIC makes 1234 display as \"1.234E3\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","ALL_V2_WITH_DELETIONS","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"geotimeSeriesValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Resolved data values pointed to by a reference.","plainTextDescription":"Resolved data values pointed to by a reference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"}}}},"restrictedView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"}}}},"stream":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"}}}},"mediaSetView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"}}}},"direct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"}}}},"geotimeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"}}}},"editsOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"}}}},"dataset":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"}}}},"table":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.\n","plainTextDescription":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"threeDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"twoDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}}},"typeReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"}}}},"void":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VoidType"}}}},"entrySet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"null":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"NullType"}}}},"interfaceObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Query parameters or outputs.\n","plainTextDescription":"A union of all the types supported by Ontology Query parameters or outputs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.\n","plainTextDescription":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups with the specified width.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the value type in the API in camelCase format.","plainTextDescription":"The name of the value type in the API in camelCase format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"humanReadable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"}}}},"timecode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[false]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\n\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"},"type":{"type":"object","object":{"properties":{"responses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.\n","plainTextDescription":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property bound to a single column in the backing datasource.","plainTextDescription":"A property bound to a single column in the backing datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"},"type":{"type":"enum","enum":{"values":["NANOSECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS"]}},"safety":"SAFE","documentation":{"description":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","plainTextDescription":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked object type.","plainTextDescription":"A reference to the linked object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKeyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object identifier containing an object type API name and primary key.","plainTextDescription":"An object identifier containing an object type API name and primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"numNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.\n","plainTextDescription":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.","example":[]}},"similarityThreshold":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.\n","plainTextDescription":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.","example":[]}},"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet containing the top `numNeighbors` objects with `propertyIdentifier` nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\n\nA non-zero score for each resulting object is returned when the `orderType` in the `orderBy` field is set to\n`relevance`. Note that:\n - Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction \n or intersection with non-nearestNeighbors object sets.\n - If results have scores, the order of the scores will be decreasing (duplicate scores are possible).\n","plainTextDescription":"ObjectSet containing the top numNeighbors objects with propertyIdentifier nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\nA non-zero score for each resulting object is returned when the orderType in the orderBy field is set to\nrelevance. Note that:\n\nScores will not be returned if a nearestNeighbors object set is composed through union, subtraction\nor intersection with non-nearestNeighbors object sets.\nIf results have scores, the order of the scores will be decreasing (duplicate scores are possible).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Reason"},"type":{"type":"object","object":{"properties":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"},"type":{"type":"enum","enum":{"values":["ACCURATE","APPROXIMATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelStrategy"},"type":{"type":"enum","enum":{"values":["PREFER_EXISTING","PREFER_DEFAULT","EXISTING_ONLY","DEFAULT_ONLY"]}},"safety":"SAFE","documentation":{"description":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to `PREFER_EXISTING`.\n\n- `PREFER_EXISTING`: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\n- `PREFER_DEFAULT`: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\n- `EXISTING_ONLY`: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\n- `DEFAULT_ONLY`: use the default channel configured in ontology metadata only; error if none is configured.\n","plainTextDescription":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to PREFER_EXISTING.\n\nPREFER_EXISTING: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\nPREFER_DEFAULT: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\nEXISTING_ONLY: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\nDEFAULT_ONLY: use the default channel configured in ontology metadata only; error if none is configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.\n","plainTextDescription":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying any of the rules in the query\n","plainTextDescription":"Matches intervals satisfying any of the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}},"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"}}}},"groupMember":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"}}}},"objectPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"arraySize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}},"unevaluable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. |\n| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. |\n| `oneOf` | The parameter has a manually predefined set of options. |\n| `range` | The parameter value must be within the defined range. |\n| `stringLength` | The parameter value must have a length within the defined range. |\n| `stringRegexMatch` | The parameter value must match a predefined regular expression. |\n| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |\n","plainTextDescription":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| arraySize | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| groupMember | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| objectPropertyValue | The parameter value must be a property value of an object found within an object set. |\n| objectQueryResult | The parameter value must be the primary key of an object found within an object set. |\n| oneOf | The parameter has a manually predefined set of options. |\n| range | The parameter value must be within the defined range. |\n| stringLength | The parameter value must have a length within the defined range. |\n| stringRegexMatch | The parameter value must match a predefined regular expression. |\n| unevaluable | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesValueBankProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesV2Response"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherText"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A value encrypted with [Cipher](/docs/foundry/cipher/overview/), stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example `CIPHER::{cipherChannelRid}::::CIPHER`).\n","plainTextDescription":"A value encrypted with Cipher, stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example CIPHER::{cipherChannelRid}::::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"},"type":{"type":"enum","enum":{"values":["ASCENDING_NULLS_LAST","DESCENDING_NULLS_LAST"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologyValueTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"},"type":{"type":"enum","enum":{"values":["SECONDS","MILLISECONDS"]}},"safety":"SAFE","documentation":{"description":"Specifies the unit of the input duration value.","plainTextDescription":"Specifies the unit of the input duration value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"},"type":{"type":"enum","enum":{"values":["DATE_FORMAT_RELATIVE_TO_NOW","DATE_FORMAT_DATE","DATE_FORMAT_YEAR_AND_MONTH","DATE_FORMAT_DATE_TIME","DATE_FORMAT_DATE_TIME_SHORT","DATE_FORMAT_TIME","DATE_FORMAT_ISO_INSTANT"]}},"safety":"SAFE","documentation":{"description":"Localized date/time format types.","plainTextDescription":"Localized date/time format types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field starts with the provided value.","plainTextDescription":"Returns objects where the specified field starts with the provided value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}}],"errors":[{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action type is not found, or the user does not have access to it.","plainTextDescription":"The action type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MalformedPropertyFilters"},"errorType":"INVALID_ARGUMENT","parameters":{"malformedPropertyFilter":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`.\n","plainTextDescription":"At least one of requested filters are malformed. Please look at the documentation of PropertyFilter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValue"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyEditsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"editsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"editsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.\n","plainTextDescription":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotSynced"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.\n","plainTextDescription":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupCountExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"groupsCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"groupsLimit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiNamesNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"derivedPropertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested derived property API names already exist on the object set.","plainTextDescription":"At least one of the requested derived property API names already exist on the object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterInterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an interface type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an interface type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedInterfaceBasedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","plainTextDescription":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByValue"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.\n","plainTextDescription":"Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentType"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The `Content-Type` cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.\n","plainTextDescription":"The Content-Type cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkPropertyMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property could not be mapped to a Marketplace installation.","plainTextDescription":"The given property could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinitionOnInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.\n","plainTextDescription":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested properties are not found on the object type.","plainTextDescription":"The requested properties are not found on the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionInvalidInput"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadPropertyNotBackedByMediaSetView"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.\n","plainTextDescription":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortOrder"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortOrder":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.\n","plainTextDescription":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFiltersCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided filters cannot be used together.","plainTextDescription":"The provided filters cannot be used together.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadDestinationNotConfigured"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.\n","plainTextDescription":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFilterable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and\n*Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked *Searchable* and *Selectable* and when it can be used.\n","plainTextDescription":"Results could not be filtered by the requested properties. Please mark the properties as Searchable and\nSelectable in the Ontology Manager to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked Searchable and Selectable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.\n","plainTextDescription":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DuplicateOrderBy"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order includes duplicate properties.","plainTextDescription":"The requested sort order includes duplicate properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionEncounteredUserFacingError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParametersNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"unknownParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"configuredParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field\nto see which ones are available.\n","plainTextDescription":"The provided parameter ID was not found for the action. Please look at the configuredParameterIds field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingInterfaceProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property types are not present on every object type.","plainTextDescription":"The requested interface property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HighScaleComputationNotEnabled"},"errorType":"TIMEOUT","parameters":{},"documentation":{"description":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","plainTextDescription":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value type is not found, or the user does not have access to it.","plainTextDescription":"The value type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidUserId"},"errorType":"INVALID_ARGUMENT","parameters":{"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a user id must be a UUID.","plainTextDescription":"The provided value for a user id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationNestedObjectSetSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"objectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"objectsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.\n","plainTextDescription":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinition"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition was invalid due to shape of query or type checking.","plainTextDescription":"Derived property definition was invalid due to shape of query or type checking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.\n","plainTextDescription":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryNotFound"},"errorType":"NOT_FOUND","parameters":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query is not found, or the user does not have access to it.","plainTextDescription":"The query is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DistinctEnumValuesExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"maxDistinctValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","plainTextDescription":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingValueTypeReference"},"errorType":"INVALID_ARGUMENT","parameters":{"referencedRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","plainTextDescription":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypesSearchNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The search on the property types are not supported. See the `Search Objects` documentation for\na list of supported search queries on different property types.\n","plainTextDescription":"The search on the property types are not supported. See the Search Objects documentation for\na list of supported search queries on different property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryOutputValue"},"errorType":"INVALID_ARGUMENT","parameters":{"outputDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"outputValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.\n","plainTextDescription":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterBaseType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterDataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set is not supported.","plainTextDescription":"The requested object set is not supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryVersionNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query could not be found at the provided version.\n","plainTextDescription":"The query could not be found at the provided version.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested shared property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property was not found on the interface type.","plainTextDescription":"The requested interface property was not found on the interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncingObjectTypes"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more requested object types have been changed in the **Ontology Manager** and changes are currently being\napplied. Wait a few seconds and try again.\n","plainTextDescription":"One or more requested object types have been changed in the Ontology Manager and changes are currently being\napplied. Wait a few seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRange"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation range should include one lt or lte and one gt or gte.\n","plainTextDescription":"Aggregation range should include one lt or lte and one gt or gte.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryMemoryExceededLimit"},"errorType":"TIMEOUT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Memory limits were exceeded for the `Query` execution.\n","plainTextDescription":"Memory limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTimeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Time limits were exceeded for the `Query` execution.\n","plainTextDescription":"Time limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CompositePrimaryKeyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RateLimitReached"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.\n","plainTextDescription":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDefinitionOutOfSync"},"errorType":"CONFLICT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The ontology definition is temporarily out of sync. The indexed definition does not yet \nreflect the latest saved definition for this type. This is typically a transient condition that \nresolves as indexing completes.\n","plainTextDescription":"The ontology definition is temporarily out of sync. The indexed definition does not yet\nreflect the latest saved definition for this type. This is typically a transient condition that\nresolves as indexing completes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBaseTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IncompatibleNestedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.\n","plainTextDescription":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnauthorizedCipherOperation"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to take a specific Cipher operation.\n","plainTextDescription":"The provided token does not have permission to take a specific Cipher operation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentLength"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A `Content-Length` header is required for all uploads, but was missing or invalid.","plainTextDescription":"A Content-Length header is required for all uploads, but was missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplePropertyValuesNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.\n","plainTextDescription":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a runtime error.\n","plainTextDescription":"The authored Query failed to execute because of a runtime error.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to edit this `ObjectType`.\n","plainTextDescription":"The user does not have permission to edit this ObjectType.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSearchable"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Search is not enabled on the specified properties. Please mark the properties as *Searchable*\nin the **Ontology Manager** to enable search on them. There may be a short delay\nbetween the time a property is marked *Searchable* and when it can be used.\n","plainTextDescription":"Search is not enabled on the specified properties. Please mark the properties as Searchable\nin the Ontology Manager to enable search on them. There may be a short delay\nbetween the time a property is marked Searchable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentNotFound"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested attachment is not found, or the client token does not have access to it. \nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.\n","plainTextDescription":"The requested attachment is not found, or the client token does not have access to it.\nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionContainsDuplicateEdits"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The given action request has multiple edits on the same object.","plainTextDescription":"The given action request has multiple edits on the same object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not found, or the client token does not have access to it.","plainTextDescription":"The requested object type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidTransactionEditPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `DataValue` for details on\nhow properties are represented for transaction edits.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of DataValue for details on\nhow properties are represented for transaction edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotFound"},"errorType":"NOT_FOUND","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.\n","plainTextDescription":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParentAttachmentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to parent attachments.\n","plainTextDescription":"The user does not have permission to parent attachments.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid interface property type for duration groupBy.\n","plainTextDescription":"Invalid interface property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DefaultAndNullGroupsNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Exact match groupBy clause cannot specify a default value and allow null values.\n","plainTextDescription":"Exact match groupBy clause cannot specify a default value and allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidGroupId"},"errorType":"INVALID_ARGUMENT","parameters":{"groupId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a group id must be a UUID.","plainTextDescription":"The provided value for a group id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyNotFound"},"errorType":"NOT_FOUND","parameters":{"ontologyRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested Ontology is not found, or the client token does not have access to it.","plainTextDescription":"The requested Ontology is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncing"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a\nfew seconds and try again.\n","plainTextDescription":"The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a\nfew seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property type is not of the expected type.\n","plainTextDescription":"The given property type is not of the expected type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid property type for duration groupBy.\n","plainTextDescription":"Invalid property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksNotSupported"},"errorType":"FAILED_PRECONDITION","parameters":{},"documentation":{"description":"Bulk loading object set links is not supported by Object Storage v1.\n","plainTextDescription":"Bulk loading object set links is not supported by Object Storage v1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleMediaUploadDestinations"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.\n","plainTextDescription":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an object type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an object type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionNotFound"},"errorType":"NOT_FOUND","parameters":{"actionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action is not found, or the user does not have access to it.","plainTextDescription":"The action is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnknownParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"expectedParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameters were not found. Please look at the `knownParameters` field\nto see which ones are available.\n","plainTextDescription":"The provided parameters were not found. Please look at the knownParameters field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionNotSupportedWithTransaction"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The function runtime does not support execution with a transaction.\n","plainTextDescription":"The function runtime does not support execution with a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectSetRidNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object set RID is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object set RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDerivedPropertyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.\n","plainTextDescription":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValueForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsReadOnlyEntity"},"errorType":"INVALID_ARGUMENT","parameters":{"entityTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action request performs edits on a type that is read-only or does not allow edits.","plainTextDescription":"The given action request performs edits on a type that is read-only or does not allow edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidVectorDimension"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"providedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","plainTextDescription":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrdering"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.\n","plainTextDescription":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotResolvable"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.\n","plainTextDescription":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkIdsDoNotExistInActionType"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownUniqueIdentifierLinkIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.\n","plainTextDescription":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortType"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","plainTextDescription":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Failed to find a provided property for a given object.\n","plainTextDescription":"Failed to find a provided property for a given object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRidNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type RID is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The object the user is attempting to create already exists.\n","plainTextDescription":"The object the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiNameNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"ontologyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","plainTextDescription":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object set is not found, or the client token does not have access to it.","plainTextDescription":"The requested object set is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The link type is not found, or the user does not have access to it.","plainTextDescription":"The link type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMemoryExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"memoryUsedBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"memoryLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFiltersNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for\na list of supported property filters.\n","plainTextDescription":"At least one of the requested property filters are not supported. See the documentation of PropertyFilter for\na list of supported property filters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The link the user is attempting to create already exists.\n","plainTextDescription":"The link the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDepthExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"depth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"depthLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.\n","plainTextDescription":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidRangeQuery"},"errorType":"INVALID_ARGUMENT","parameters":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}},"field":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The specified query range filter is invalid.\n","plainTextDescription":"The specified query range filter is invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ViewObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.\n","plainTextDescription":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"metricType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.\n","plainTextDescription":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by interface property type.\n","plainTextDescription":"Range group by is not supported by interface property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `PropertyValue` for details on\nhow properties are represented.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of PropertyValue for details on\nhow properties are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionValidationFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The validation failed for the given action parameters. Please use the `validateAction` endpoint for more\ndetails.\n","plainTextDescription":"The validation failed for the given action parameters. Please use the validateAction endpoint for more\ndetails.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSortable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and\n*Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay\nbetween the time a property is set to *Searchable* and *Sortable* and when it can be used.\n","plainTextDescription":"Results could not be ordered by the requested properties. Please mark the properties as Searchable and\nSortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay\nbetween the time a property is set to Searchable and Sortable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleGroupByOnFieldNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"duplicateFields":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation cannot group by on the same field multiple times.\n","plainTextDescription":"Aggregation cannot group by on the same field multiple times.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The linked object with the given primary key is not found, or the user does not have access to it.","plainTextDescription":"The linked object with the given primary key is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFoundOnObject"},"errorType":"INVALID_ARGUMENT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectPropertyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","plainTextDescription":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface link type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface link type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectChanged"},"errorType":"CONFLICT","parameters":{"primaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An object used by this `Action` was changed by someone else while the `Action` was running.\n","plainTextDescription":"An object used by this Action was changed by someone else while the Action was running.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditedPropertiesNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.\n","plainTextDescription":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionTimedOut"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidApplyActionOptionCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidCombination":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given options are individually valid but cannot be used in the given combination.","plainTextDescription":"The given options are individually valid but cannot be used in the given combination.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConsistentSnapshotError"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.\n","plainTextDescription":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SimilarityThresholdOutOfRange"},"errorType":"INVALID_ARGUMENT","parameters":{"providedThreshold":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","plainTextDescription":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFilterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyFilterValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\n`isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type.\n","plainTextDescription":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\nisNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryEncounteredUserFacingError"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored Query failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsNotSupportedWithMarketplace"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Returning action edits is not supported when using marketplace bindings.\n","plainTextDescription":"Returning action edits is not supported when using marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypesNotSynced"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.\n","plainTextDescription":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypesNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface types were not found, or the client token does not have access to it.","plainTextDescription":"The requested interface types were not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingSharedProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property types are not present on every object type.","plainTextDescription":"The requested shared property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrderingWithNullValues"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.\n","plainTextDescription":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"fileSizeBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fileLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.\n","plainTextDescription":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsModifiedConcurrently"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.\n","plainTextDescription":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyExactMatchingNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that does not support exact matching is used in a setting that requires exact matching.","plainTextDescription":"A property that does not support exact matching is used in a setting that requires exact matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeDoesNotSupportNearestNeighbors"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","plainTextDescription":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotCipherFormatted"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHER::::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHERCIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object is not found, or the client token does not have access to it.","plainTextDescription":"The requested object is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidOrderType"},"errorType":"INVALID_ARGUMENT","parameters":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This query type does not support the provided order type","plainTextDescription":"This query type does not support the provided order type","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the **Ontology Manager**.\n","plainTextDescription":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TooManyNearestNeighborsRequested"},"errorType":"INVALID_ARGUMENT","parameters":{"requestedNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"maxNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","plainTextDescription":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceBasedObjectSetNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set type is not supported for interface-based object sets.","plainTextDescription":"The requested object set type is not supported for interface-based object sets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BranchNotSupportedWithMarketplaceQuery"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The branch parameter is not supported when executing queries with marketplace bindings.\n","plainTextDescription":"The branch parameter is not supported when executing queries with marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UndecryptableValue"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER:::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditMissingPrimaryKey"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.\n","plainTextDescription":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by property type.\n","plainTextDescription":"Range group by is not supported by property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidFields"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given field does not match the expected pattern. For example, an Ontology object property `id`\nshould be written `properties.id`.\n","plainTextDescription":"The value of the given field does not match the expected pattern. For example, an Ontology object property id\nshould be written properties.id.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"localObjectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Required parameters are missing. Please look at the `parameters` field to see which required parameters are\nmissing from the request.\n","plainTextDescription":"Required parameters are missing. Please look at the parameters field to see which required parameters are\nmissing from the request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRidAlreadyExists"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided attachment RID already exists and cannot be overwritten.\n","plainTextDescription":"The provided attachment RID already exists and cannot be overwritten.","example":[]}}]}; diff --git a/packages/docs-spec-platform/src/generated/namespaces/OntologiesV2.ts b/packages/docs-spec-platform/src/generated/namespaces/OntologiesV2.ts index f3d232cfb..198e90a8a 100644 --- a/packages/docs-spec-platform/src/generated/namespaces/OntologiesV2.ts +++ b/packages/docs-spec-platform/src/generated/namespaces/OntologiesV2.ts @@ -17,4 +17,4 @@ import type { Namespace } from "../../ir/Namespace.js"; // dprint-ignore -export const OntologiesV2: Namespace = {"name":"Ontologies","version":"v2","outputAuditVersions":"V3_ONLY","resources":[{"singleton":false,"documentation":{"description":"Ontologies are categorizations of data into real-world concepts. Those concepts are represented by object types, properties, link types, and action types. Together, these concepts form a descriptive object graph that links together all the key entities in an organization.\n\nFor more information, please refer to the [Ontology](/docs/foundry/ontology/overview/) user documentation.\n\n:::callout{theme=neutral title=Note}\nOntology changes are eventually consistent, and it may take few minutes for the API to reflect new Ontologies. \nAfter adding a new Ontology, the API may return an `OntologyNotFound` error for a few minutes.\n:::\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyV2"},"pluralName":"OntologiesV2","operations":[{"name":"listOntologiesV2","verb":"list","documentation":{"description":"Lists the Ontologies visible to the current user.\n","plainTextDescription":"Lists the Ontologies visible to the current user.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies","httpMethod":"GET","parameters":[],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"},{"apiName":"shared-ontology","displayName":"Shared ontology","description":"The ontology shared with our suppliers","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesV2Response"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOntologyV2","verb":"get","documentation":{"description":"Gets a specific ontology for a given Ontology API name or RID.\n","plainTextDescription":"Gets a specific ontology for a given Ontology API name or RID.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOntologyFullMetadata","verb":"getFullMetadata","documentation":{"description":"Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces.\nThis endpoint is designed to return as much metadata as possible in a single request to support OSDK workflows.\nIt may omit certain entities rather than fail the request.\n","plainTextDescription":"Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces.\nThis endpoint is designed to return as much metadata as possible in a single request to support OSDK workflows.\nIt may omit certain entities rather than fail the request.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/fullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"loadOntologyMetadata","verb":"loadMetadata","documentation":{"description":"Load Ontology metadata for the requested object, link, action, query, and interface types.\n","plainTextDescription":"Load Ontology metadata for the requested object, link, action, query, and interface types.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/metadata","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadOntologyMetadataRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An action type represents a set of changes and logic that can be applied in the Ontology. Action types are \ncreated in the **Ontology Manager**. For more information, refer to the\n[action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ActionTypeV2"},"pluralName":"ActionTypesV2","operations":[{"name":"listActionTypesV2","verb":"list","documentation":{"description":"Lists the action types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the action types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},{"apiName":"move-office","description":"Update an office's physical location","parameters":{"officeId":{"dataType":{"type":"string"}},"newAddress":{"description":"The office's new physical address (not necessarily shipping address)","dataType":{"type":"string"}},"newCapacity":{"description":"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)","dataType":{"type":"integer"}}},"rid":"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchActionTypesV2","verb":"search","documentation":{"description":"Search for action types in the given Ontology that match the provided filters. Results are returned by\nrelevance of the match unless an explicit `orderBy` is provided.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. Search results are eventually\nconsistent with the latest Ontology version and may lag slightly behind the last Ontology modification.\n","plainTextDescription":"Search for action types in the given Ontology that match the provided filters. Results are returned by\nrelevance of the match unless an explicit orderBy is provided.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. Search results are eventually\nconsistent with the latest Ontology version and may lag slightly behind the last Ontology modification.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/search","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to search the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to search the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"where":{"type":"actionTypeDisplayName","value":{"type":"contains","value":"promote"}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"totalCount":"1","data":[{"apiName":"promote-employee","description":"Update an employee's title and compensation","rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeV2","verb":"get","documentation":{"description":"Gets a specific action type with the given API name.\n","plainTextDescription":"Gets a specific action type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/{actionType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The name of the action type in the API.\n","plainTextDescription":"The name of the action type in the API.","example":["promote-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeByRid","verb":"getByRid","documentation":{"description":"Gets a specific action type with the given RID.\n","plainTextDescription":"Gets a specific action type with the given RID.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionTypeRid","documentation":{"description":"The RID of the action type.\n","plainTextDescription":"The RID of the action type.","example":["ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeByRidBatch","verb":"getByRidBatch","documentation":{"description":"Gets a list of action types by RID in bulk.\n\nAction types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of action types by RID in bulk.\nAction types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequest"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An action type represents a set of changes and logic that can be applied in the Ontology. Action types are \ncreated in the **Ontology Manager**. For more information, refer to the\n[action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"},"pluralName":"ActionTypesFullMetadata","operations":[{"name":"listActionTypesFullMetadata","verb":"list","documentation":{"description":"Lists the action types (with full metadata) for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the action types (with full metadata) for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypesFullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectTypeApiNames","documentation":{"description":"A set of object type API names that can be used to filter which actions are returned.\n","plainTextDescription":"A set of object type API names that can be used to filter which actions are returned.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"actionType":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},"fullLogicRule":[{"createObject":{"objectTypeApiName":"promote-employee","propertyArguments":{"employeeId":{"objectParameterPropertyValue":{"parameterId":"employeeId","propertyTypeApiName":"employeeId"}},"title":{"parameterId":{"parameterId":"newTitle"}},"compensation":{"parameterId":{"parameterId":"newCompensation"}}}}}]}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesFullMetadataResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeFullMetadata","verb":"get","documentation":{"description":"Gets the full metadata associated with an action type.\n","plainTextDescription":"Gets the full metadata associated with an action type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/{actionType}/fullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"description":"The API name of the ontology. To find the API name, use the **List ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the ontology. To find the API name, use the List ontologies endpoint or\ncheck the Ontology Manager.","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The name of the action type in the API.\n","plainTextDescription":"The name of the action type in the API.","example":["promote-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"actionType":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},"fullLogicRule":[{"createObject":{"objectTypeApiName":"promote-employee","propertyArguments":{"employeeId":{"objectParameterPropertyValue":{"parameterId":"employeeId","propertyTypeApiName":"employeeId"}},"title":{"parameterId":{"parameterId":"newTitle"}},"compensation":{"parameterId":{"parameterId":"newCompensation"}}}}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeFullMetadataBatch","verb":"getFullMetadataBatch","documentation":{"description":"Gets a list of action types with full metadata (parameters and logic rules) by their API names in\nbulk.\n\nAction types are filtered from the response if they don't exist, the requesting token lacks the\nrequired permissions, or any of their logic rules are not supported by this API, so the response may\ncontain fewer entries than requested.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of action types with full metadata (parameters and logic rules) by their API names in\nbulk.\nAction types are filtered from the response if they don't exist, the requesting token lacks the\nrequired permissions, or any of their logic rules are not supported by this API, so the response may\ncontain fewer entries than requested.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/getFullMetadataBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"This represents an object type within a Foundry Ontology. For more information, review the \n[Object Type](/docs/foundry/object-link-types/object-types-overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"},"pluralName":"ObjectTypesV2","operations":[{"name":"listObjectTypesV2","verb":"list","documentation":{"description":"Lists the object types for the given Ontology.\n\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.\n\nNote: the `aliases` field is not populated on this endpoint and will always be empty. To retrieve object type\naliases, use the get-by-RID read paths (e.g. `getObjectTypeV2`).\n","plainTextDescription":"Lists the object types for the given Ontology.\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.\nNote: the aliases field is not populated on this endpoint and will always be empty. To retrieve object type\naliases, use the get-by-RID read paths (e.g. getObjectTypeV2).","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the object types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the object types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"includeDatasources","documentation":{"description":"When set to `true`, the `datasources` field on each returned object type is populated with the\ndatasources backing it. Defaults to `false`.\n","plainTextDescription":"When set to true, the datasources field on each returned object type is populated with the\ndatasources backing it. Defaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","displayName":"Employee","status":"ACTIVE","primaryKey":"employeeId","properties":{"employeeId":{"dataType":{"type":"integer"},"rid":"ri.ontology.main.property.571d3d4d-150a-4dd4-b1a7-d16c1ed7d996"},"fullName":{"dataType":{"type":"string"},"rid":"ri.ontology.main.property.5721baa7-26d5-4ca8-b092-d47dcc724ab1"},"office":{"description":"The unique ID of the employee's primary assigned office","dataType":{"type":"string"},"rid":"ri.ontology.main.property.554fa8c4-3b6e-4d3f-adef-acc9f0f54633"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","dataType":{"type":"date"},"rid":"ri.ontology.main.property.3b081417-fe68-4010-ade8-68b298116ed4"},"rid":"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"}},{"apiName":"office","description":"A physical location (not including rented co-working spaces)","displayName":"Office","status":"ACTIVE","primaryKey":"officeId","properties":{"officeId":{"dataType":{"type":"string"}},"address":{"description":"The office's physical address (not necessarily shipping address)","dataType":{"type":"string"}},"capacity":{"description":"The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)","dataType":{"type":"integer"}},"rid":"ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesV2Response"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeV2","verb":"get","documentation":{"description":"Gets a specific object type with the given API name.\n","plainTextDescription":"Gets a specific object type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"includeDatasources","documentation":{"description":"When set to `true`, the `datasources` field on the returned object type is populated with the\ndatasources backing it. Defaults to `false`.\n","plainTextDescription":"When set to true, the datasources field on the returned object type is populated with the\ndatasources backing it. Defaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","displayName":"Employee","status":"ACTIVE","primaryKey":"employeeId","properties":{"employeeId":{"dataType":{"type":"integer"},"rid":"ri.ontology.main.property.571d3d4d-150a-4dd4-b1a7-d16c1ed7d996"},"fullName":{"dataType":{"type":"string"},"rid":"ri.ontology.main.property.5721baa7-26d5-4ca8-b092-d47dcc724ab1"},"office":{"description":"The unique ID of the employee's primary assigned office","dataType":{"type":"string"},"rid":"ri.ontology.main.property.554fa8c4-3b6e-4d3f-adef-acc9f0f54633"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","dataType":{"type":"date"},"rid":"ri.ontology.main.property.3b081417-fe68-4010-ade8-68b298116ed4"}},"rid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeByRidBatch","verb":"getByRidBatch","documentation":{"description":"Gets a list of object types by RID in bulk.\n\nObject types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of object types by RID in bulk.\nObject types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequest"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeFullMetadata","verb":"getFullMetadata","documentation":{"description":"Gets the full metadata for a specific object type with the given API name.\n","plainTextDescription":"Gets the full metadata for a specific object type with the given API name.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"includeDatasources","documentation":{"description":"When set to `true`, the `datasources` field on the returned object type is populated with the\ndatasources backing it. Defaults to `false`.\n","plainTextDescription":"When set to true, the datasources field on the returned object type is populated with the\ndatasources backing it. Defaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeFullMetadataBatch","verb":"getFullMetadataBatch","documentation":{"description":"Gets the full metadata for a batch of object types, identified by their API names.\n\nSet `includeLinkTypes` to return every outgoing link type for each object type alongside its metadata,\nwithout needing to know the link type API names. Link types are ordered by their API name.\n\nObject types are returned in the order they were requested. Any that don't exist or that the requesting\ntoken lacks permissions for are silently omitted.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets the full metadata for a batch of object types, identified by their API names.\nSet includeLinkTypes to return every outgoing link type for each object type alongside its metadata,\nwithout needing to know the link type API names. Link types are ordered by their API name.\nObject types are returned in the order they were requested. Any that don't exist or that the requesting\ntoken lacks permissions for are silently omitted.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/getFullMetadataBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeEditsHistory","verb":"getEditsHistory","documentation":{"description":"Returns the history of edits (additions, modifications, deletions) for objects of a\nspecific object type. This endpoint provides visibility into all actions that have\nmodified objects of this type.\n\nThe edits are returned in reverse chronological order (most recent first) by default. \n\nNote that filters are ignored for OSv1 object types.\n","plainTextDescription":"Returns the history of edits (additions, modifications, deletions) for objects of a\nspecific object type. This endpoint provides visibility into all actions that have\nmodified objects of this type.\nThe edits are returned in reverse chronological order (most recent first) by default.\nNote that filters are ignored for OSv1 object types.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"description":"The ontology RID or API name","plainTextDescription":"The ontology RID or API name","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type","plainTextDescription":"The API name of the object type","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch from which we will get edits history. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch from which we will get edits history. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to get edits history from.\n","plainTextDescription":"The resource identifier of an ontology scenario to get edits history from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response","plainTextDescription":"Success response","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOutgoingLinkTypesV2","verb":"listOutgoingLinkTypes","documentation":{"description":"List the outgoing links for an object type.\n","plainTextDescription":"List the outgoing links for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Flight"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the outgoing link types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the outgoing link types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned.","plainTextDescription":"The desired size of the page to be returned.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"originAirport","objectTypeApiName":"Airport","cardinality":"ONE","foreignKeyPropertyApiName":"originAirportId"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingLinkTypeV2","verb":"getOutgoingLinkType","documentation":{"description":"Get an outgoing link for an object type.\n","plainTextDescription":"Get an outgoing link for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the outgoing link.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the outgoing link.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"directReport","objectTypeApiName":"Employee","cardinality":"MANY"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingLinkTypesByObjectTypeRidBatch","verb":"getOutgoingLinkTypesByObjectTypeRidBatch","documentation":{"description":"Gets outgoing link types for a batch of object types, identified by their RIDs.\n\nFor each requested object type, returns the list of outgoing link types visible to the\nrequesting token. Optionally, results can be filtered to only include specific link type RIDs.\n\nObject types that don't exist or that the requesting token lacks permissions for are\nsilently omitted from the response.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets outgoing link types for a batch of object types, identified by their RIDs.\nFor each requested object type, returns the list of outgoing link types visible to the\nrequesting token. Optionally, results can be filtered to only include specific link type RIDs.\nObject types that don't exist or that the requesting token lacks permissions for are\nsilently omitted from the response.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequest"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Object is a data container for a specific instance of an [Object Type](/docs/foundry/object-link-types/object-types-overview/). For instance, the Employee object type may contain data about several employees, and each one is represented as a single Object.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"},"pluralName":"OntologyObjectsV2","operations":[{"name":"listObjectsV2","verb":"list","documentation":{"description":"Lists the objects for the given Ontology and object type.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the objects for the given Ontology and object type.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":50030,"__apiName":"Employee","id":50030,"firstName":"John","lastName":"Doe"},{"__rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","__primaryKey":20090,"__apiName":"Employee","id":20090,"firstName":"John","lastName":"Haymore"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectV2","verb":"get","documentation":{"description":"Gets a specific object with the given primary key.\n","plainTextDescription":"Gets a specific object with the given primary key.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the requested object. To look up the expected primary key for your object type, use the\n`Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested object. To look up the expected primary key for your object type, use the\nGet object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the object from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the object from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":50030,"__apiName":"Employee","id":50030,"firstName":"John","lastName":"Doe"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"countObjects","verb":"count","documentation":{"description":"Returns a count of the objects of the given object type.\n","plainTextDescription":"Returns a count of the objects of the given object type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/count","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to count the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to count the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"count":100}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchObjectsV2","verb":"search","documentation":{"description":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| 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 term 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| startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string |\n\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\n","plainTextDescription":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| 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 term 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| startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string |\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'\"~). Periods (.) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/search","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"where":{"type":"eq","field":"age","value":21}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"__rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb","__primaryKey":1000,"__apiName":"Employee","employeeId":1000,"lastName":"smith","firstName":"john","age":21}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"aggregateObjectsV2","verb":"aggregate","documentation":{"description":"Perform functions on object fields in the specified ontology and object type.\n","plainTextDescription":"Perform functions on object fields in the specified ontology and object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/aggregate","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The type of the object to aggregate on.","plainTextDescription":"The type of the object to aggregate on.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"aggregation":[{"type":"min","field":"tenure","name":"min_tenure"},{"type":"avg","field":"tenure","name":"avg_tenure"}],"where":{"type":"eq","field":"name","value":"john"},"groupBy":[{"field":"startDate","type":"range","ranges":[{"startValue":"2020-01-01","endValue":"2020-06-01"}]},{"field":"city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Linked Object describes a object that is linked to another object.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"LinkedObjectV2"},"pluralName":"LinkedObjectsV2","operations":[{"name":"listLinkedObjectsV2","verb":"listLinkedObjects","documentation":{"description":"Lists the linked objects for a specific object and the given link type.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the linked objects for a specific object and the given link type.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list linked objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list linked objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"__rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","__primaryKey":80060,"__apiName":"Employee","id":80060,"firstName":"Anna","lastName":"Smith"},{"__rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","__primaryKey":51060,"__apiName":"Employee","id":51060,"firstName":"James","lastName":"Matthews"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getLinkedObjectV2","verb":"getLinkedObject","documentation":{"description":"Get a specific linked object that originates from another object.\n\nIf there is no link between the two objects, `LinkedObjectNotFound` is thrown.\n","plainTextDescription":"Get a specific linked object that originates from another object.\nIf there is no link between the two objects, LinkedObjectNotFound is thrown.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkedObjectPrimaryKey","documentation":{"description":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the Get object type endpoint (passing the linked object type) or the Ontology Manager.","example":[80060]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":50030,"__apiName":"Employee","id":50030,"firstName":"John","lastName":"Doe"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Attachment Property is a property that references a file attachment.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"AttachmentPropertyV2"},"pluralName":"AttachmentPropertiesV2","operations":[{"name":"listPropertyAttachments","verb":"getAttachment","documentation":{"description":"Get the metadata of attachments parented to the given object.\n","plainTextDescription":"Get the metadata of attachments parented to the given object.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"type":"single","rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentMetadataResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentPropertyByRidV2","verb":"getAttachmentByRid","documentation":{"description":"Get the metadata of a particular attachment in an attachment list.\n","plainTextDescription":"Get the metadata of a particular attachment in an attachment list.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentPropertyContentV2","verb":"readAttachment","documentation":{"description":"Get the content of an attachment.\n","plainTextDescription":"Get the content of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentPropertyContentByRidV2","verb":"readAttachmentByRid","documentation":{"description":"Get the content of an attachment by its RID.\n\nThe RID must exist in the attachment array of the property.\n","plainTextDescription":"Get the content of an attachment by its RID.\nThe RID must exist in the attachment array of the property.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A MediaReference Property is a property that references a media item.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"MediaReferenceProperty"},"pluralName":"MediaReferenceProperties","operations":[{"name":"readMediaContent","verb":"getMediaContent","documentation":{"description":"Gets the content of a media item referenced by this property.\n","plainTextDescription":"Gets the content of a media item referenced by this property.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the media reference property.\n","plainTextDescription":"The primary key of the object with the media reference property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the media reference property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the media reference property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["profile_picture"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The content stream.","plainTextDescription":"The content stream.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaMetadata","verb":"getMediaMetadata","documentation":{"description":"Gets metadata about the media item referenced by this property.\n","plainTextDescription":"Gets metadata about the media item referenced by this property.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/metadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the media reference property.\n","plainTextDescription":"The primary key of the object with the media reference property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the media reference backed property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the media reference backed property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"sizeBytes":123,"path":"example.png","mediaType":"image/png"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MediaMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"uploadMediaContent","verb":"upload","documentation":{"description":":::callout{theme=warning title=Warning}\nThis endpoint is deprecated. Use the **Upload media** endpoint to upload a media item and receive a\ntemporary media reference instead.\n:::\nUploads a media item to the media set which backs the specified property. The property must be backed by a single media set and branch, otherwise an error will be thrown.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n","plainTextDescription":"This endpoint is deprecated. Use the Upload media endpoint to upload a media item and receive a\ntemporary media reference instead.\n\nUploads a media item to the media set which backs the specified property. The property must be backed by a single media set and branch, otherwise an error will be thrown.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/media/{property}/upload","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the media reference property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the media reference property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["profile_picture"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"A path for the media item within its backing media set. Required if the backing media set requires paths.\n","plainTextDescription":"A path for the media item within its backing media set. Required if the backing media set requires paths.","example":["my-file.png"]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"The media reference for the uploaded media.","plainTextDescription":"The media reference for the uploaded media.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReference"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Time Series property is a property that contains a time series of data points.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"TimeSeriesPropertyV2"},"pluralName":"TimeSeriesPropertiesV2","operations":[{"name":"getFirstPoint","verb":"getFirstPoint","documentation":{"description":"Get the first point of a time series property.\n","plainTextDescription":"Get the first point of a time series property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series property. To find the API name for your time series property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series property. To find the API name for your time series property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":false}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getLastPoint","verb":"getLastPoint","documentation":{"description":"Get the last point of a time series property.\n","plainTextDescription":"Get the last point of a time series property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series property. To find the API name for your time series property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series property. To find the API name for your time series property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":false}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"streamPoints","verb":"streamPoints","documentation":{"description":"Stream all of the points of a time series property.\n","plainTextDescription":"Stream all of the points of a time series property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series property. To find the API name for your time series property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series property. To find the API name for your time series property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"format","documentation":{"description":"The output format to serialize the output binary stream in. Default is\nJSON. ARROW is more efficient than JSON at streaming a large sized response.\n","plainTextDescription":"The output format to serialize the output binary stream in. Default is\nJSON. ARROW is more efficient than JSON at streaming a large sized response.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamingOutputFormat"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"range":{"type":"relative","startTime":{"when":"BEFORE","value":5,"unit":"MONTHS"},"endTime":{"when":"BEFORE","value":1,"unit":"MONTHS"}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":["eyJkYXRhIjpbeyJ0aW1lIjoiMjAyMC0wMy0wNlQxMjowMDowMFoiLCJ2YWx1ZSI6NDguNX0seyJ0aW1lIjoiMjAyMC0wMy0wNlQxMzowMDowMFoiLCJ2YWx1ZSI6NzUuMDF9LHsidGltZSI6IjIwMjAtMDMtMDZUMTQ6MDA6MDBaIiwidmFsdWUiOjMxLjMzfV19"]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Time Series Value Bank property is a property that contains a series of time based data points.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"TimeSeriesValueBankProperty"},"pluralName":"TimeSeriesValueBankProperties","operations":[{"name":"getLatestValue","verb":"getLatestValue","documentation":{"description":"Get the latest value of a property backed by a timeseries. If a specific geotime series integration has both a history and a live integration, we will give precedence to the live integration.\n","plainTextDescription":"Get the latest value of a property backed by a timeseries. If a specific geotime series integration has both a history and a live integration, we will give precedence to the live integration.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{propertyName}/latestValue","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the timeseries property.\n","plainTextDescription":"The primary key of the object with the timeseries property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"propertyName","documentation":{"description":"The API name of the timeseries property. To find the API name for your property value bank property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the timeseries property. To find the API name for your property value bank property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":false}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"streamValues","verb":"streamValues","documentation":{"description":"Stream all of the points of a time series property (this includes geotime series references).\n","plainTextDescription":"Stream all of the points of a time series property (this includes geotime series references).","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamValues","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series backed property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series backed property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"range":{"type":"relative","startTime":{"when":"BEFORE","value":5,"unit":"MONTHS"},"endTime":{"when":"BEFORE","value":1,"unit":"MONTHS"}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":["eyJkYXRhIjpbeyJ0aW1lIjoiMjAyMC0wMy0wNlQxMjowMDowMFoiLCJ2YWx1ZSI6NDguNX0seyJ0aW1lIjoiMjAyMC0wMy0wNlQxMzowMDowMFoiLCJ2YWx1ZSI6NzUuMDF9LHsidGltZSI6IjIwMjAtMDMtMDZUMTQ6MDA6MDBaIiwidmFsdWUiOjMxLjMzfV19"]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Geotemporal Series property is a property that contains a series of time-based geographic positions.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesProperty"},"pluralName":"GeotemporalSeriesProperties","operations":[{"name":"loadGeotemporalSeriesEntries","verb":"loadGeotemporalSeriesEntries","documentation":{"description":"Load the geotemporal series entries for a given object's geotemporal series reference property within the\nspecified time range.\n\nEach entry in the response is a map of property names to values, following the same structure as\n`OntologyObjectV2`. Use the `additionalProperties` field in the request to control which properties are included\nin each entry depending on the underlying geotemporal integration.\n\nResults are paginated. Use the `nextPageToken` from the response to retrieve subsequent pages.\n\n:::callout{theme=warning title=Warning}\n Geotemporal series integrations with only \"dataset archive\" enabled are not supported.\n:::\n","plainTextDescription":"Load the geotemporal series entries for a given object's geotemporal series reference property within the\nspecified time range.\nEach entry in the response is a map of property names to values, following the same structure as\nOntologyObjectV2. Use the additionalProperties field in the request to control which properties are included\nin each entry depending on the underlying geotemporal integration.\nResults are paginated. Use the nextPageToken from the response to retrieve subsequent pages.\n\nGeotemporal series integrations with only \"dataset archive\" enabled are not supported.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/geotemporalSeries/{property}/loadEntries","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or check the\n**Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or check the\nOntology Manager.","example":["airplane"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the geotemporal series property.\n","plainTextDescription":"The primary key of the object with the geotemporal series property.","example":["XYZ123"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the geotemporal series property. To find the API name for your property, check the\n**Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the geotemporal series property. To find the API name for your property, check the\nOntology Manager or use the Get object type endpoint.","example":["locationHistory"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package RID of the generated SDK.\n","plainTextDescription":"The package RID of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"range":{"startTime":"2020-01-01T00:00:00Z","endTime":"2020-06-01T00:00:00Z"},"additionalProperties":["speed","heading"],"pageSize":100}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"time":"2020-03-06T12:00:00Z","position":{"type":"Point","coordinates":[-122.4194,37.7749]},"speed":120.5,"heading":275.3},{"time":"2020-03-06T13:00:00Z","position":{"type":"Point","coordinates":[-122.4095,37.7845]},"speed":95,"heading":180}],"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZQ"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A CipherText property is a property that contains data encrypted with [Cipher](/docs/foundry/cipher/overview/).\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"CipherTextProperty"},"pluralName":"CipherTextProperties","operations":[{"name":"decrypt","verb":"decrypt","documentation":{"description":"Decrypt the value of a ciphertext property.\n","plainTextDescription":"Decrypt the value of a ciphertext property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the CipherText property.\n","plainTextDescription":"The primary key of the object with the CipherText property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DecryptionResult"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"encryptWithDefaultChannel","verb":"encryptWithDefaultChannel","documentation":{"description":"Encrypt a plaintext value into a CipherText value for the given object type property.\n\nThe Cipher Channel used is the default channel configured for the property in ontology metadata. This\nendpoint requires the CipherText property to have a configured `defaultCipherChannelRid`; if none is\nconfigured an error will be thrown. To encrypt against the channel of an existing object's value, use the\n**Encrypt** endpoint that accepts a `primaryKey` instead.\n","plainTextDescription":"Encrypt a plaintext value into a CipherText value for the given object type property.\nThe Cipher Channel used is the default channel configured for the property in ontology metadata. This\nendpoint requires the CipherText property to have a configured defaultCipherChannelRid; if none is\nconfigured an error will be thrown. To encrypt against the channel of an existing object's value, use the\nEncrypt endpoint that accepts a primaryKey instead.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/ciphertexts/{property}/encrypt","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"plaintext":"Jane Doe"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"encrypt","verb":"encrypt","documentation":{"description":"Encrypt a plaintext value into a CipherText value for the given object's CipherText property.\n\nThe Cipher Channel used is resolved based on the supplied `cipherChannelStrategy`, using the channel of the\nobject's existing ciphertext value and/or the default channel configured for the property in ontology metadata.\n","plainTextDescription":"Encrypt a plaintext value into a CipherText value for the given object's CipherText property.\nThe Cipher Channel used is resolved based on the supplied cipherChannelStrategy, using the channel of the\nobject's existing ciphertext value and/or the default channel configured for the property in ontology metadata.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/encrypt","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the CipherText property.\n","plainTextDescription":"The primary key of the object with the CipherText property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"cipherChannelStrategy","documentation":{"description":"The strategy controlling which Cipher Channel is used to encrypt the value. If not specified, defaults\nto `PREFER_EXISTING`.\n","plainTextDescription":"The strategy controlling which Cipher Channel is used to encrypt the value. If not specified, defaults\nto PREFER_EXISTING.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelStrategy"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"plaintext":"Jane Doe"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Interface describes the contract that a set of Object Types will implement.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyInterface"},"pluralName":"OntologyInterfaces","operations":[{"name":"listInterfaceTypes","verb":"list","documentation":{"description":"Lists the interface types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the interface types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the interface types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the interface types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"Athlete","displayName":"Athlete","description":"Good at sportsball","properties":{"name":{"rid":"com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b","apiName":"name","displayName":"Name","dataType":"string"}},"extendsInterfaces":["Human"],"rid":"ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getInterfaceType","verb":"get","documentation":{"description":"Gets a specific interface type with the given API name.\n","plainTextDescription":"Gets a specific interface type with the given API name.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the interface type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the interface type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"Athlete","displayName":"Athlete","description":"Good at sportsball","properties":{"name":{"rid":"com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b","apiName":"name","displayName":"Name","dataType":"string"}},"extendsInterfaces":["Human"],"rid":"ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listObjectsForInterface","verb":"listObjectsForInterface","documentation":{"description":"Lists the objects for the given Ontology and interface type.\n\nNote that this endpoint does not guarantee consistency, unless you use the snapshot flag specified below. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the objects for the given Ontology and interface type.\nNote that this endpoint does not guarantee consistency, unless you use the snapshot flag specified below. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"description":"The API name of the ontology. To find the API name, use the **List ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the ontology. To find the API name, use the List ontologies endpoint or\ncheck the Ontology Manager.","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the interface type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the interface type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":50030,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":50030,"firstName":"John","lastName":"Doe"},{"$rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","$primaryKey":20090,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":20090,"firstName":"John","lastName":"Haymore"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsForInterfaceResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchObjectsForInterface","verb":"search","documentation":{"description":":::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:::\nSearch 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 \nqueries 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\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\n\nAttempting to use an unsupported query will result in a validation error. Third-party applications using this \nendpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n","plainTextDescription":"This endpoint will be removed once TS OSDK is updated to use objectSets/loadObjects with interface object\nsets.\n\nSearch 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\nqueries are supported:\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 |\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'\"~). Periods (.) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\nAttempting to use an unsupported query will result in a validation error. Third-party applications using this\nendpoint via OAuth2 must request the following operation scope: api:ontologies-read.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}/search","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsForInterfaceRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"__rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb","__primaryKey":1000,"__apiName":"Employee","employeeId":1000,"lastName":"smith","firstName":"john","age":21}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"aggregateObjectsForInterface","verb":"aggregate","documentation":{"description":":::callout{theme=warning title=Warning}\nThis endpoint will be removed once TS OSDK is updated to use `objectSets/aggregate` with interface object\nsets.\n:::\nPerform functions on object fields in the specified ontology and of the specified interface type. Any \nproperties specified in the query must be shared property type API names defined on the interface.\n","plainTextDescription":"This endpoint will be removed once TS OSDK is updated to use objectSets/aggregate with interface object\nsets.\n\nPerform functions on object fields in the specified ontology and of the specified interface type. Any\nproperties specified in the query must be shared property type API names defined on the interface.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"aggregation":[{"type":"min","field":"tenure","name":"min_tenure"},{"type":"avg","field":"tenure","name":"avg_tenure"}],"where":{"type":"eq","field":"name","value":"john"},"groupBy":[{"field":"startDate","type":"range","ranges":[{"startValue":"2020-01-01","endValue":"2020-06-01"}]},{"field":"city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOutgoingInterfaceLinkTypes","verb":"listOutgoingInterfaceLinkTypes","documentation":{"description":"List the outgoing interface link types for an interface type.\n","plainTextDescription":"List the outgoing interface link types for an interface type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}/outgoingLinkTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingInterfaceLinkTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingInterfaceLinkType","verb":"getOutgoingInterfaceLinkType","documentation":{"description":"Get an outgoing interface link type for an interface type.\n","plainTextDescription":"Get an outgoing interface link type for an interface type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}/outgoingLinkTypes/{interfaceLinkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceLinkType","documentation":{"description":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the **Ontology Manager** page for the \nparent interface.\n","plainTextDescription":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the Ontology Manager page for the\nparent interface.","example":["worksAt"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listInterfaceLinkedObjects","verb":"listInterfaceLinkedObjects","documentation":{"description":"Lists the linked objects for a specific object and the given interface link type.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the linked objects for a specific object and the given interface link type.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}/{objectType}/{primaryKey}/links/{interfaceLinkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"description":"The API name of the ontology. To find the API name, use the **List ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the ontology. To find the API name, use the List ontologies endpoint or\ncheck the Ontology Manager.","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceLinkType","documentation":{"description":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the **Ontology Manager** page for the \nparent interface.\n","plainTextDescription":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the Ontology Manager page for the\nparent interface.","example":["worksAt"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which to **start** the interface link traversal. To look up the expected \nprimary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which to start the interface link traversal. To look up the expected\nprimary key for your object type, use the Get object type endpoint or the Ontology Manager.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":50030,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":50030,"firstName":"John","lastName":"Doe"},{"$rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","$primaryKey":20090,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":20090,"firstName":"John","lastName":"Haymore"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceLinkedObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Action represents one application of an action type. You may use them in the API to apply changes to the \nOntology. For more information, refer to the [action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Action"},"pluralName":"Actions","operations":[{"name":"applyActionV2","verb":"apply","documentation":{"description":"Applies an action using the given parameters. \n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that a 200 HTTP status code only indicates that the request was received and processed by the server. \nSee the validation result in the response body to determine if the action was applied successfully.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n","plainTextDescription":"Applies an action using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that a 200 HTTP status code only indicates that the request was received and processed by the server.\nSee the validation result in the response body to determine if the action was applied successfully.\nNote that parameter default values are not currently supported by\nthis endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/apply","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to apply the action against.\n","plainTextDescription":"The resource identifier of an ontology scenario to apply the action against.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"operationId":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367","validation":{"result":"VALID"},"parameters":{"id":{"evaluatedConstraints":[],"result":"VALID","required":true},"newName":{"evaluatedConstraints":[],"result":"VALID","required":true}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]},{"name":"applyActionAsyncV2","verb":"applyAsync","documentation":{"description":"Applies an action using the given parameters. \n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n","plainTextDescription":"Applies an action using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that parameter default values are not currently supported by\nthis endpoint.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyAsync","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"operationId":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponseV2"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"applyActionBatchV2","verb":"applyBatch","documentation":{"description":"Applies multiple actions (of the same Action Type) using the given parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\n\nNote that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint.\n","plainTextDescription":"Applies multiple actions (of the same Action Type) using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\nNote that notifications are not currently supported by this endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"applyActionWithOverrides","verb":"applyWithOverrides","documentation":{"description":"Same as regular apply action operation, but allows specifying overrides for UniqueIdentifier and\nCurrentTime generated action parameters.\n","plainTextDescription":"Same as regular apply action operation, but allows specifying overrides for UniqueIdentifier and\nCurrentTime generated action parameters.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyWithOverrides","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to apply the action against.\n","plainTextDescription":"The resource identifier of an ontology scenario to apply the action against.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"request":{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},"overrides":{"uniqueIdentifierLinkIdValues":{"fd28fa5c-3028-4eca-bdc8-3be2c7949cd9":"4efdb11f-c1e3-417c-89fb-2225118b65e3"},"actionExecutionTime":"2025-10-25T13:00:00Z"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionWithOverridesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"validation":{"result":"VALID"},"parameters":{"id":{"evaluatedConstraints":[],"result":"VALID","required":true},"newName":{"evaluatedConstraints":[],"result":"VALID","required":true}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]},{"name":"applyActionBatchWithOverrides","verb":"applyBatchWithOverrides","documentation":{"description":"Applies multiple actions (of the same Action Type) with per-item overrides\nfor UniqueIdentifier and CurrentTime generated action parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\n\nNote that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint.\n","plainTextDescription":"Applies multiple actions (of the same Action Type) with per-item overrides\nfor UniqueIdentifier and CurrentTime generated action parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\nNote that notifications are not currently supported by this endpoint.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyBatchWithOverrides","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"},"overrides":{"uniqueIdentifierLinkIdValues":{"fd28fa5c-3028-4eca-bdc8-3be2c7949cd9":"4efdb11f-c1e3-417c-89fb-2225118b65e3"},"actionExecutionTime":"2025-10-25T13:00:00Z"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionWithOverridesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using\n[Query Functions](/docs/foundry/functions/query-functions/).\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"QueryType"},"pluralName":"QueryTypes","operations":[{"name":"listQueryTypesV2","verb":"list","documentation":{"description":"Lists the query types for the given Ontology.\n\nEach query type is returned at its latest version. The latest version is the one that was most recently\npublished, which may be a pre-release version.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the query types for the given Ontology.\nEach query type is returned at its latest version. The latest version is the one that was most recently\npublished, which may be a pre-release version.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queryTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list queries from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list queries from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 100.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 100.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"dataType":{"type":"string"},"description":"The city to search for employees in","required":true}},"output":{"dataType":{"type":"array","required":true,"subType":{"type":"object","objectApiName":"Employee"}},"required":true},"rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"},{"apiName":"getAverageTenureOfEmployees","displayName":"Get Average Tenure","description":"Gets the average tenure of all employees","parameters":{"employees":{"dataType":{"type":"string"},"description":"An object set of the employees to calculate the average tenure of","required":true},"useMedian":{"dataType":{"type":"boolean"},"description":"An optional flag to use the median instead of the mean, defaults to false","required":false}},"output":{"dataType":{"type":"double"},"required":true},"rid":"ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400","version":"2.1.1"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getQueryTypeV2","verb":"get","documentation":{"description":"Gets a specific query type with the given API name.\n","plainTextDescription":"Gets a specific query type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queryTypes/{queryApiName}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the query type. To find the API name, use the **List query types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the query type. To find the API name, use the List query types endpoint or\ncheck the Ontology Manager.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"version","documentation":{"description":"The version of the Query to get. If not specified, the latest version is used. The latest version is\nthe one that was most recently published, including pre-release versions.\n","plainTextDescription":"The version of the Query to get. If not specified, the latest version is used. The latest version is\nthe one that was most recently published, including pre-release versions.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"dataType":{"type":"string"},"description":"The city to search for employees in","required":true}},"output":{"dataType":{"type":"array","subType":{"type":"object","objectApiName":"Employee"}},"required":true},"rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getQueryTypeByRidBatch","verb":"getByRidBatch","documentation":{"description":"Gets a list of query types by RID in bulk.\n\nQuery types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of query types by RID in bulk.\nQuery types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queryTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the query type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the query type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using\n[Query Functions](/docs/foundry/functions/query-functions/).\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Query"},"pluralName":"Queries","operations":[{"name":"executeQueryV2","verb":"execute","documentation":{"description":"Executes a Query using the given parameters. By default, the latest version of the Query is executed. \nThe latest version is the one that was most recently published, which may be a pre-release version.\n\nOptional parameters do not need to be supplied.\n","plainTextDescription":"Executes a Query using the given parameters. By default, the latest version of the Query is executed.\nThe latest version is the one that was most recently published, which may be a pre-release version.\nOptional parameters do not need to be supplied.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queries/{queryApiName}/execute","httpMethod":"POST","parameters":[{"name":"attribution","documentation":{"description":"The Attribution to be used when executing this request.\n","plainTextDescription":"The Attribution to be used when executing this request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the Query to execute.\n","plainTextDescription":"The API name of the Query to execute.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"version","documentation":{"description":"The version of the Query to execute. If not specified, the latest version is used. The latest version\nis the one that was most recently published, including pre-release versions. When used\nwith `branch`, the specified version must exist on the branch.\n","plainTextDescription":"The version of the Query to execute. If not specified, the latest version is used. The latest version\nis the one that was most recently published, including pre-release versions. When used\nwith branch, the specified version must exist on the branch.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to execute the query from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\nWhen provided without `version`, the latest version on this branch is used, including pre-release versions.\nWhen provided with `version`, the specified version must exist on the branch.\n","plainTextDescription":"The Foundry branch to execute the query from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\nWhen provided without version, the latest version on this branch is used, including pre-release versions.\nWhen provided with version, the specified version must exist on the branch.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to execute the query on.\n","plainTextDescription":"The resource identifier of an ontology scenario to execute the query on.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"city":"New York"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"value":["EMP546","EMP609","EMP989"]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An object set represents a set of objects in the Ontology. You can use object sets to perform operations on \nmultiple objects at once.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyObjectSet"},"pluralName":"OntologyObjectSets","operations":[{"name":"createTemporaryObjectSetV2","verb":"createTemporary","documentation":{"description":"Creates a temporary `ObjectSet` from the given definition. This `ObjectSet` expires after one hour.\n","plainTextDescription":"Creates a temporary ObjectSet from the given definition. This ObjectSet expires after one hour.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyLogicCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/createTemporary","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to reference. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to reference. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"base","objectType":"Employee"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"objectSetRid":"ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetResponseV2"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectSetV2","verb":"get","documentation":{"description":"Gets the definition of the `ObjectSet` with the given RID.\n","plainTextDescription":"Gets the definition of the ObjectSet with the given RID.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyLogicAccess"],"auth":{"includeAuthHeader":true,"scopes":[],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/{objectSetRid}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectSetRid","documentation":{"description":"The RID of the object set.\n","plainTextDescription":"The RID of the object set.","example":["ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"objectSet":{"type":"base","objectType":"Employee"}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"loadObjectSetV2","verb":"load","documentation":{"description":"Load the ontology objects present in the `ObjectSet` from the provided object set definition.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nNote that null value properties will not be returned.\n\nVector properties will not be returned unless included in the `select` parameter.\n","plainTextDescription":"Load the ontology objects present in the ObjectSet from the provided object set definition.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nNote that null value properties will not be returned.\nVector properties will not be returned unless included in the select parameter.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadObjects","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object set from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object set from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to load the object set from.\n","plainTextDescription":"The resource identifier of an ontology scenario to load the object set from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"__rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851","__primaryKey":50030,"__apiName":"Employee","employeeId":50030,"firstName":"John","lastName":"Smith","age":21},{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":20090,"__apiName":"Employee","employeeId":20090,"firstName":"John","lastName":"Haymore","age":27}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"loadObjectSetV2MultipleObjectTypes","verb":"loadMultipleObjectTypes","documentation":{"description":"Load the ontology objects present in the `ObjectSet` from the provided object set definition. The resulting \nobjects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped \nto an interface, in which only the object type properties that implement the properties of any interfaces in its \nscope are returned. For objects that are scoped to an interface in the result, a mapping from interface to \nobject implementation is returned in order to interpret the objects as the interfaces that they implement.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in `loadObjects`.\n\nVector properties will not be returned unless included in the `select` parameter.\n","plainTextDescription":"Load the ontology objects present in the ObjectSet from the provided object set definition. The resulting\nobjects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped\nto an interface, in which only the object type properties that implement the properties of any interfaces in its\nscope are returned. For objects that are scoped to an interface in the result, a mapping from interface to\nobject implementation is returned in order to interpret the objects as the interfaces that they implement.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in loadObjects.\nVector properties will not be returned unless included in the select parameter.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to load the object set from.\n","plainTextDescription":"The resource identifier of an ontology scenario to load the object set from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"$rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851","$primaryKey":50030,"$apiName":"Employee","employeeId":50030,"employeeName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":20090,"$apiName":"Employee","employeeId":20090,"employeeName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b71","$primaryKey":23,"$apiName":"Athlete","jerseyNumber":23,"firstName":"Michael"}],"totalCount":"3,","interfaceToObjectTypeMappings":{"Person":{"Employee":{"first":"employeeName","identifier":"employeeId"},"Athlete":{"first":"firstName","identifier":"jerseyNumber"}}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"loadObjectSetV2ObjectsOrInterfaces","verb":"loadObjectsOrInterfaces","documentation":{"description":"Load the ontology objects present in the `ObjectSet` from the provided object set definition. If the requested \nobject set contains interfaces and the object can be viewed as an interface, it will contain the properties \ndefined by the interface. If not, it will contain the properties defined by its object type. This allows directly\nloading all objects of an interface where all objects are viewed as the interface, for example.\n\nNote that the result object set cannot contain a mix of objects with \"interface\" properties and \"object type\"\nproperties. Attempting to load an object set like this will result in an error.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in `/loadObjects`.\n\nVector properties will not be returned unless included in the `select` parameter.\n","plainTextDescription":"Load the ontology objects present in the ObjectSet from the provided object set definition. If the requested\nobject set contains interfaces and the object can be viewed as an interface, it will contain the properties\ndefined by the interface. If not, it will contain the properties defined by its object type. This allows directly\nloading all objects of an interface where all objects are viewed as the interface, for example.\nNote that the result object set cannot contain a mix of objects with \"interface\" properties and \"object type\"\nproperties. Attempting to load an object set like this will result in an error.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in /loadObjects.\nVector properties will not be returned unless included in the select parameter.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to load the objects or interfaces from.\n","plainTextDescription":"The resource identifier of an ontology scenario to load the objects or interfaces from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"interfaceBase","interfaceType":"Person"},"pageSize":10000,"pageToken":"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"$rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851","$primaryKey":50030,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","personId":50030,"firstName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":20090,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","personID":20090,"firstName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b71","$primaryKey":23,"$objectTypeApiName":"Athlete","$interfaceTypeApiName":"Person","personId":23,"firstName":"Michael"}],"totalCount":3}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"aggregateObjectSetV2","verb":"aggregate","documentation":{"description":"Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.\n","plainTextDescription":"Aggregates the ontology objects present in the ObjectSet from the provided object set definition.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/aggregate","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to aggregate the objects on.\n","plainTextDescription":"The resource identifier of an ontology scenario to aggregate the objects on.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"objectType":"Employee","type":"base"},"aggregation":[{"field":"tenure","name":"min_tenure","type":"min"},{"field":"tenure","name":"avg_tenure","type":"avg"}],"groupBy":[{"field":"startDate","ranges":[{"endValue":"2020-06-01","startValue":"2020-01-01"}],"type":"range"},{"field":"city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectSetRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"loadObjectSetLinksV2","verb":"loadLinks","documentation":{"description":"Loads the specified links from the defined object set. \n\nLinks are defined as a link type API name and object locators for the source and target objects\nwhere only the `__primaryKey` and `__apiName` properties are loaded.\n\nLinks are grouped by source object locator; however, the links for a given source object may be\nsplit over multiple entries with the same source object locator.\n\nPlease keep these limitations in mind:\n- Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\n- This endpoint requests links for 1,000 objects at a time. If, for any page of 1,000 objects, there are more\n than 100,000 links present, results are limited to 100,000 links and should be considered partial.\n- This endpoint does not support OSv1 links and will return an error if links provided are backed by OSv1.\n- This endpoint currently does not support interface object sets or interface links, but support will be added in the near future.\n","plainTextDescription":"Loads the specified links from the defined object set.\nLinks are defined as a link type API name and object locators for the source and target objects\nwhere only the __primaryKey and __apiName properties are loaded.\nLinks are grouped by source object locator; however, the links for a given source object may be\nsplit over multiple entries with the same source object locator.\nPlease keep these limitations in mind:\n\nLinks returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\nThis endpoint requests links for 1,000 objects at a time. If, for any page of 1,000 objects, there are more\nthan 100,000 links present, results are limited to 100,000 links and should be considered partial.\nThis endpoint does not support OSv1 links and will return an error if links provided are backed by OSv1.\nThis endpoint currently does not support interface object sets or interface links, but support will be added in the near future.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadLinks","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"objectType":"Employee","type":"base"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Attachment is a file that acts like a parameter of an object. Attachments are uploaded as temporary files \nand attached to objects via actions. Attachments are configured in the **Ontology Manager**. For more information, \nplease checkout the [Upload attachments](/docs/foundry/action-types/upload-attachments/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Attachment"},"pluralName":"Attachments","operations":[{"name":"uploadAttachmentV2","verb":"upload","documentation":{"description":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n","plainTextDescription":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.","example":[]},"releaseStage":"STABLE","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/upload","httpMethod":"POST","parameters":[{"name":"Content-Length","documentation":{"description":"The size in bytes of the file content being uploaded.","plainTextDescription":"The size in bytes of the file content being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentLength"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Type","documentation":{"description":"The media type of the file being uploaded.","plainTextDescription":"The media type of the file being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentType"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"The name of the file being uploaded.","plainTextDescription":"The name of the file being uploaded.","example":["My Image.jpeg"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"uploadAttachmentWithRid","verb":"uploadWithRid","documentation":{"description":"This endpoint is identical to `/v2/ontologies/attachments/upload` but additionally accepts a previously\ngenerated `AttachmentRid`.\n","plainTextDescription":"This endpoint is identical to /v2/ontologies/attachments/upload but additionally accepts a previously\ngenerated AttachmentRid.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/upload/{attachmentRid}","httpMethod":"POST","parameters":[{"name":"attachmentRid","documentation":{"description":"The `AttachmentRid` of the attachment being uploaded.","plainTextDescription":"The AttachmentRid of the attachment being uploaded.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Length","documentation":{"description":"The size in bytes of the file content being uploaded.","plainTextDescription":"The size in bytes of the file content being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentLength"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Type","documentation":{"description":"The media type of the file being uploaded.","plainTextDescription":"The media type of the file being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentType"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"The name of the file being uploaded.","plainTextDescription":"The name of the file being uploaded.","example":["My Image.jpeg"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentContentV2","verb":"read","documentation":{"description":"Get the content of an attachment.\n","plainTextDescription":"Get the content of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/{attachmentRid}/content","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentV2","verb":"get","documentation":{"description":"Get the metadata of an attachment.\n","plainTextDescription":"Get the metadata of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/{attachmentRid}","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"[Value types](/docs/foundry/object-link-types/value-types-overview/) are custom types that add semantic meaning and constraints to Foundry data.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyValueType"},"pluralName":"OntologyValueTypes","operations":[{"name":"getOntologyValueType","verb":"get","documentation":{"description":"Gets a specific value type with the given API name.\n","plainTextDescription":"Gets a specific value type with the given API name.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/valueTypes/{valueType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"valueType","documentation":{"description":"The API name of the value type. To find the API name, use the **List value types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the value type. To find the API name, use the List value types endpoint or\ncheck the Ontology Manager.","example":["countryCode"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"countryInitials","description":"A three letter code for a top-level administrative region","displayName":"Country Initials","status":"ACTIVE","fieldType":"string","rid":"ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c719d","constraints":[{"type":"length","length":{"minimumLength":3,"maximumLength":3}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOntologyValueTypes","verb":"list","documentation":{"description":"Lists the latest versions of the value types for the given Ontology.\n","plainTextDescription":"Lists the latest versions of the value types for the given Ontology.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/valueTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"apiName":"validNorthAmericanCountries","description":"Options for valid countries in North America","displayName":"Valid North American Countries","status":"ACTIVE","fieldType":"string","rid":"ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c719d","constraints":[{"type":"enum","enum":{"options":["USA","Mexico","Canada"]}}]},{"apiName":"countyCode","description":"A three letter code for a US County.","displayName":"County Code","status":"ACTIVE","fieldType":"string","rid":"ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c8232","constraints":[{"type":"length","length":{"minimumLength":3,"maximumLength":3}}]}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOntologyValueTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"Transactions contain a set of edits to objects and links that can be applied to the ontology,\nsimilar to applying an action. You can use a transaction to perform read operations that reflect the proposed edits,\nand stage all edits at once to the ontology. Currently, Transaction RIDs can only be used from\nwithin functions backing actions.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyTransaction"},"pluralName":"OntologyTransactions","operations":[{"name":"ontologyTransactionPostEdits","verb":"postEdits","documentation":{"description":"Applies a set of edits to a transaction in order.\n","plainTextDescription":"Applies a set of edits to a transaction in order.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/transactions/{transactionId}/edits","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of the transaction to apply edits to.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of the transaction to apply edits to.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Transaction edits were applied successfully.","plainTextDescription":"Transaction edits were applied successfully.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An OntologyScenario represents a sandboxed data-fork of the ontology, allowing you to conduct simulations on your\nontology without affecting production data. You can create scenarios, perform read and write actions on the scenario,\nand merge the changes on the scenario back to the ontology.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyScenario"},"pluralName":"OntologyScenarios","operations":[{"name":"createOntologyScenario","verb":"createScenario","documentation":{"description":"Creates an ontology scenario.\n","plainTextDescription":"Creates an ontology scenario.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyLogicCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/create","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"base":{"type":"branch","branch":"my-branch"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Successfully created a scenario.","plainTextDescription":"Successfully created a scenario.","example":[{"scenarioRid":"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedObjectTypes","verb":"listScenarioEditedObjectTypes","documentation":{"description":"Returns the list of object type API names that have been modified within a given scenario.\n","plainTextDescription":"Returns the list of object type API names that have been modified within a given scenario.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objectTypes/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedLinkTypes","verb":"listScenarioEditedLinkTypes","documentation":{"description":"Returns the list of outgoing links that have been modified within a given scenario for an object type.\n\nNote that only many-to-many link type are returned by this endpoint. One-to-many link type edits are\nsurfaced as object edits on the object type that owns the foreign key property.\n","plainTextDescription":"Returns the list of outgoing links that have been modified within a given scenario for an object type.\nNote that only many-to-many link type are returned by this endpoint. One-to-many link type edits are\nsurfaced as object edits on the object type that owns the foreign key property.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objectTypes/{objectType}/outgoingLinkTypes/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Flight"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinkTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedEntityTypes","verb":"listScenarioEditedEntityTypes","documentation":{"description":"Returns the object types and link types that have been modified within a given scenario.\n\nThe response contains the list of object type API names that have been modified, and the list of\nmany-to-many link types that have been modified, grouped by their source object type. One-to-many\nlink type edits are surfaced as object edits on the object type that owns the foreign key property.\n","plainTextDescription":"Returns the object types and link types that have been modified within a given scenario.\nThe response contains the list of object type API names that have been modified, and the list of\nmany-to-many link types that have been modified, grouped by their source object type. One-to-many\nlink type edits are surfaced as object edits on the object type that owns the foreign key property.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/editedEntityTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedEntityTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedObjects","verb":"listScenarioEditedObjects","documentation":{"description":"Returns the list of objects that have been edited within a given scenario for a specific object type.\nOnly objects that the user has permission to view are returned.\n\nEach page may be smaller than the requested page size.\n","plainTextDescription":"Returns the list of objects that have been edited within a given scenario for a specific object type.\nOnly objects that the user has permission to view are returned.\nEach page may be smaller than the requested page size.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type.\n","plainTextDescription":"The API name of the object type.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The maximum number of objects to return per page.\n","plainTextDescription":"The maximum number of objects to return per page.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"description":"The page token to use for pagination.\n","plainTextDescription":"The page token to use for pagination.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedLinks","verb":"listScenarioEditedLinks","documentation":{"description":"Returns the list of edited links within a given scenario for a specific object type and link type, grouped\nby source object. Only works for many-to-many link types. Only links where the user has permission to view\nboth objects are returned.\n\nEach page may be smaller than the requested page size.\n","plainTextDescription":"Returns the list of edited links within a given scenario for a specific object type and link type, grouped\nby source object. Only works for many-to-many link types. Only links where the user has permission to view\nboth objects are returned.\nEach page may be smaller than the requested page size.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/links/{linkType}/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type.\n","plainTextDescription":"The API name of the object type.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link type.\n","plainTextDescription":"The API name of the link type.","example":["employeeReportsTo"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The maximum number of links to return per page.\n","plainTextDescription":"The maximum number of links to return per page.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"description":"The page token to use for pagination.\n","plainTextDescription":"The page token to use for pagination.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinksResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioConflictingObjects","verb":"listScenarioConflictingObjects","documentation":{"description":"Returns the list of objects with edits that conflict with edits to the scenario's base for a specific object\ntype. A conflict occurs when an object has been edited both within the scenario and on the scenario's base\nafter the scenario was created. Only objects that the user has permission to view are returned.\n\nConflict detection takes into account changes that are not reflected in the user-visible object data.\nAs a result, this endpoint may report false positives. An object may be returned as conflicting even if\nits data has not actually changed on the scenario's base.\n\nEach page may be smaller than the requested page size.\n","plainTextDescription":"Returns the list of objects with edits that conflict with edits to the scenario's base for a specific object\ntype. A conflict occurs when an object has been edited both within the scenario and on the scenario's base\nafter the scenario was created. Only objects that the user has permission to view are returned.\nConflict detection takes into account changes that are not reflected in the user-visible object data.\nAs a result, this endpoint may report false positives. An object may be returned as conflicting even if\nits data has not actually changed on the scenario's base.\nEach page may be smaller than the requested page size.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/conflicting","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type.\n","plainTextDescription":"The API name of the object type.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The maximum number of objects to examine when searching for conflicts. This bounds the work performed\nper call; it is not a guarantee on the number of conflicting objects returned, which may be smaller.\nEach page may be smaller than this value.\n","plainTextDescription":"The maximum number of objects to examine when searching for conflicts. This bounds the work performed\nper call; it is not a guarantee on the number of conflicting objects returned, which may be smaller.\nEach page may be smaller than this value.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"description":"The page token to use for pagination.\n","plainTextDescription":"The page token to use for pagination.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioConflictingObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]}],"components":[{"locator":{"namespaceName":"Ontologies","localName":"TableRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry table.","plainTextDescription":"The RID of a Foundry table.","example":["ri.tables.main.table.beb574f7-019c-4a01-abd1-ff3c97bfaec8"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"}}}},"prefix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"}}}},"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"}}}},"allTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"}}}},"phrase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"}}}},"anyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface property implementations of that object type.","plainTextDescription":"Map from object type to the interface property implementations of that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of an input to a function.\n","plainTextDescription":"The name of an input to a function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the property is backed by a restricted view that does not support property securities.","plainTextDescription":"Indicates the property is backed by a restricted view that does not support property securities.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"},"type":{"type":"object","object":{"properties":{"center":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"}}},"safety":"UNSAFE","documentation":{"example":[]}},"distance":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Distance"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The coordinate point to use as the center of the distance query.\n","plainTextDescription":"The coordinate point to use as the center of the distance query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeReferences":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a parameter against the configured constraints.","plainTextDescription":"Represents the validity of a parameter against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the PropertyType","plainTextDescription":"The API name of the PropertyType","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"},"type":{"type":"object","object":{"properties":{"position":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Position"}}},"safety":"UNSAFE","documentation":{"example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The underlying data values pointed to by a GeotimeSeriesReference.","plainTextDescription":"The underlying data values pointed to by a GeotimeSeriesReference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current time argument in a logic rule.","plainTextDescription":"Represents the current time argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionMode"},"type":{"type":"enum","enum":{"values":["ASYNC","RUN","VALIDATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types that have been modified within a scenario.\n","plainTextDescription":"The object types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an approximate number of distinct values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","plainTextDescription":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadOntologyMetadataRequest"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","plainTextDescription":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version corresponding to a codex template.","plainTextDescription":"The version corresponding to a codex template.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have been edited within the scenario.","plainTextDescription":"The list of objects that have been edited within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have been edited within a scenario for a given object type.\n\nThe Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName`\nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The objects that have been edited within a scenario for a given object type.\nThe Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched intervals must occur in order.","plainTextDescription":"If true, the matched intervals must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying all the rules in the query\n","plainTextDescription":"Matches intervals satisfying all the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a struct field in the Ontology.","plainTextDescription":"The name of a struct field in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"timeSeriesSyncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the time series.\n","plainTextDescription":"The set of properties that are bound to the time series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a time series sync, providing values for time-dependent properties.\n","plainTextDescription":"An object type datasource backed by a time series sync, providing values for time-dependent properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"},"type":{"type":"object","object":{"properties":{"ontology":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BranchMetadata"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with an api name matching the given string predicate.","plainTextDescription":"Returns action types with an api name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`.","plainTextDescription":"Represents the API POST body when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequest"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","plainTextDescription":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed \"Other\" value** toggle in the **Ontology Manager**.","plainTextDescription":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the Allowed \"Other\" value toggle in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter has a manually predefined set of options.\n","plainTextDescription":"The parameter has a manually predefined set of options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Greater than or equal.","plainTextDescription":"Greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Less than or equal.","plainTextDescription":"Less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Bounds on the size of an array-typed parameter.","plainTextDescription":"Bounds on the size of an array-typed parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"style":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"}}},"safety":"SAFE","documentation":{"example":[]}},"currencyCode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)\n","plainTextDescription":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"},"type":{"type":"object","object":{"properties":{"directSourceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.\n","plainTextDescription":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Parameter"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action or query.","plainTextDescription":"Details about a parameter of an action or query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter`, whose value type is\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter, whose value type is\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"},"type":{"type":"object","object":{"properties":{"numberType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for numeric formatting options.","plainTextDescription":"Wrapper for numeric formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the minimum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.\n","plainTextDescription":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A message containing link updates for a subscription.","plainTextDescription":"A message containing link updates for a subscription.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The numeric value of the time offset. Negative values indicate the past, positive values the future.\n","plainTextDescription":"The numeric value of the time offset. Negative values indicate the past, positive values the future.","example":[-7]}},"timeUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"}}},"safety":"SAFE","documentation":{"description":"The unit of time for the value.","plainTextDescription":"The unit of time for the value.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A point in time specified relative to query execution time.","plainTextDescription":"A point in time specified relative to query execution time.","example":[{"value":-7,"timeUnit":"DAY"}]}},{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they are revertible.","plainTextDescription":"Returns action types based on whether they are revertible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"},"type":{"type":"enum","enum":{"values":["STANDARD","SCIENTIFIC","ENGINEERING","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Number notation style options:\n- STANDARD: Regular number display (\"1,234\")\n- SCIENTIFIC: Scientific notation (\"1.234E3\")\n- ENGINEERING: Engineering notation (\"1.234E3\")\n- COMPACT: Compact notation (\"1.2K\")\n","plainTextDescription":"Number notation style options:\n\nSTANDARD: Regular number display (\"1,234\")\nSCIENTIFIC: Scientific notation (\"1.234E3\")\nENGINEERING: Engineering notation (\"1.234E3\")\nCOMPACT: Compact notation (\"1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the property in the API. To find the API name for your property, use the `Get object type`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the property in the API. To find the API name for your property, use the Get object type\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"description":"The suggested visibility of the object type.","plainTextDescription":"The suggested visibility of the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Represents a filter used on properties.\n\nEndpoints that accept this supports optional parameters that have the form:\n`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects.\nFor instance, you may use `properties.firstName.eq=John` to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\n\nThe following are a list of supported property filters:\n\n- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties\n that have at least one of the provided values. If multiple query parameters are provided, then objects\n that have any of the given values for the specified property will be matched.\n- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided\n property. If multiple query parameters are provided, then objects that have any of the given values\n will be matched. For instance, if the user provides a request by doing\n `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property\n of either John or Anna will be matched. This filter is supported on all property types except Arrays.\n- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values.\n Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values\n will be excluded from the result.\n- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt`\n `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater\n than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\n- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null.\n This filter is supported on all property types.\n","plainTextDescription":"Represents a filter used on properties.\nEndpoints that accept this supports optional parameters that have the form:\nproperties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString} to filter the returned objects.\nFor instance, you may use properties.firstName.eq=John to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\nThe following are a list of supported property filters:\n\nproperties.{propertyApiName}.contains - supported on arrays and can be used to filter array properties\nthat have at least one of the provided values. If multiple query parameters are provided, then objects\nthat have any of the given values for the specified property will be matched.\nproperties.{propertyApiName}.eq - used to filter objects that have the exact value for the provided\nproperty. If multiple query parameters are provided, then objects that have any of the given values\nwill be matched. For instance, if the user provides a request by doing\n?properties.firstName.eq=John&properties.firstName.eq=Anna, then objects that have a firstName property\nof either John or Anna will be matched. This filter is supported on all property types except Arrays.\nproperties.{propertyApiName}.neq - used to filter objects that do not have the provided property values.\nSimilar to the eq filter, if multiple values are provided, then objects that have any of the given values\nwill be excluded from the result.\nproperties.{propertyApiName}.lt, properties.{propertyApiName}.lte, properties.{propertyApiName}.gt\nproperties.{propertyApiName}.gte - represent less than, less than or equal to, greater than, and greater\nthan or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\nproperties.{propertyApiName}.isNull - used to filter objects where the provided property is (or is not) null.\nThis filter is supported on all property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Icon"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"blueprint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","plainTextDescription":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \n \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the derived property that will be returned.\n","plainTextDescription":"The name of the derived property that will be returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Ontology"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the `List shared property types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the List shared property types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the webhook with the given rid.","plainTextDescription":"Returns action types which reference the webhook with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only *properties*, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.\n","plainTextDescription":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only properties, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioRequest"},"type":{"type":"object","object":{"properties":{"base":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for creating an ontology scenario.","plainTextDescription":"The request payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"allOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"}}}},"match":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"}}}},"anyOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"}}}},"prefixOnLastToken":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"}}}},"fuzzy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Sub-rule used for evaluating an IntervalQuery","plainTextDescription":"Sub-rule used for evaluating an IntervalQuery","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a \nvariety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a\nvariety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A reference to an Ontology object property with the form `properties.{propertyApiName}`.","plainTextDescription":"A reference to an Ontology object property with the form properties.{propertyApiName}.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A reference to a UniqueIdentifierArgument linkId defined for this action type.\n","plainTextDescription":"A reference to a UniqueIdentifierArgument linkId defined for this action type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the action type in the API. To find the API name for your Action Type, use the `List action types`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the action type in the API. To find the API name for your Action Type, use the List action types\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"},"type":{"type":"object","object":{"properties":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}},"tense":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A datetime expressed as an offset from the current time.","plainTextDescription":"A datetime expressed as an offset from the current time.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"},"type":{"type":"object","object":{"properties":{"shouldLoadObjectRids":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of \nmilliseconds to the execution time, and should be avoided where not needed.\n","plainTextDescription":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of\nmilliseconds to the execution time, and should be avoided where not needed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Optional features to toggle when generating the object loading response.\n","plainTextDescription":"Optional features to toggle when generating the object loading response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.\n","plainTextDescription":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceObjectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructType"},"type":{"type":"object","object":{"properties":{"structFieldTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"mainValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A single struct field's mapping where `apiName` is the name of a struct field.\n","plainTextDescription":"A single struct field's mapping where apiName is the name of a struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"}}}},"user":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a parameter whose name matches the given string predicate.","plainTextDescription":"Returns action types with a parameter whose name matches the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"},"type":{"type":"object","object":{"properties":{"formatStyle":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"}}},"safety":"UNSAFE","documentation":{"example":[]}},"precision":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"}}}}},"safety":"SAFE","documentation":{"example":[]}},"baseValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numeric values representing time durations.\n- Human readable: 3661 seconds displays as \"1h 1m 1s\"\n- Timecode: 3661 seconds displays as \"01:01:01\"\n","plainTextDescription":"Format numeric values representing time durations.\n\nHuman readable: 3661 seconds displays as \"1h 1m 1s\"\nTimecode: 3661 seconds displays as \"01:01:01\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be within the defined range.\n","plainTextDescription":"The parameter value must be within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set \nby removing the request from subsequent ObjectSetStreamSubscribeRequests.\n","plainTextDescription":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set\nby removing the request from subsequent ObjectSetStreamSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayTimezone":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for timestamp property values.","plainTextDescription":"Formatting configuration for timestamp property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object locators to report link changes on.","plainTextDescription":"A list of object locators to report link changes on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface-to-object-type mapping for that object type.","plainTextDescription":"Map from object type to the interface-to-object-type mapping for that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"},"type":{"type":"enum","enum":{"values":["DAYS","MONTHS","QUARTERS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Negates a numeric value.\n","plainTextDescription":"Negates a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values of the object at the time of creation.\nMaps property API names to their values.\n","plainTextDescription":"The property values of the object at the time of creation.\nMaps property API names to their values.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`foreignKeyPropertyApiName` is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.\n","plainTextDescription":"foreignKeyPropertyApiName is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"scenarioReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ScenarioReferenceType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"geohash":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeohashType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Action parameters.\n","plainTextDescription":"A union of all the types supported by Ontology Action parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid UUID (Universally Unique Identifier).","plainTextDescription":"The string must be a valid UUID (Universally Unique Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"},"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\n`List ontologies` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"rolling":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"}}}},"periodic":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"}}}},"cumulative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.\n","plainTextDescription":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.\n","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified numeric range.\n","plainTextDescription":"The parameter value must fall within the specified numeric range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"structField":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"}}}},"propertyWithLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"}}}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"}}}},"primaryKeyProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An identifier used to select properties or struct fields.","plainTextDescription":"An identifier used to select properties or struct fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Randomly generated identifier for an object type's datasource.\n","plainTextDescription":"Randomly generated identifier for an object type's datasource.","example":["ri.ontology.main.datasource.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"},"type":{"type":"object","object":{"properties":{"selectedObjects":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.\n","plainTextDescription":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"},"type":{"type":"object","object":{"properties":{"minimumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"uniqueValues":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"valueConstraint":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"structFields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a singleton struct parameter.","plainTextDescription":"Represents the validity of a singleton struct parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponse"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the property values of the object.","plainTextDescription":"A map of the property values of the object.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Queries support either a vector matching the embedding model defined on the property, or text that is \nautomatically embedded.\n","plainTextDescription":"Queries support either a vector matching the embedding model defined on the property, or text that is\nautomatically embedded.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"},"type":{"type":"object","object":{"properties":{"streamRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry stream.","plainTextDescription":"An object type datasource backed by a Foundry stream.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The property API name to filter on (either field or propertyIdentifier must be provided).","plainTextDescription":"The property API name to filter on (either field or propertyIdentifier must be provided).","example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The property identifier to filter on (either field or propertyIdentifier must be provided).","plainTextDescription":"The property identifier to filter on (either field or propertyIdentifier must be provided).","example":[]}},"relativeStartTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"description":"The lower bound relative to query time (inclusive). Negative values go into the past.\nFor example, { value: -7, timeUnit: DAY } means 7 days ago.\n","plainTextDescription":"The lower bound relative to query time (inclusive). Negative values go into the past.\nFor example, { value: -7, timeUnit: DAY } means 7 days ago.","example":[]}},"relativeEndTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"description":"The upper bound relative to query time (exclusive). Negative values go into the past.\nFor example, { value: 1, timeUnit: MONTH } means the start of next month.\n","plainTextDescription":"The upper bound relative to query time (exclusive). Negative values go into the past.\nFor example, { value: 1, timeUnit: MONTH } means the start of next month.","example":[]}},"timeZoneId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.\n","plainTextDescription":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.","example":["America/New_York"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.\n","plainTextDescription":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.","example":[{"field":"numberOfSeats","timeZoneId":"America/New_York"}]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"}}}},"doesNotIntersectBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"}}}},"relativeDateRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"}}}},"wildcard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"}}}},"withinDistanceOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"}}}},"withinBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"}}}},"intersectsBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"}}}},"containsAllTermsInOrderPrefixLastTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"}}}},"containsAllTermsInOrder":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"}}}},"withinPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"}}}},"intersectsPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"}}}},"in":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InQuery"}}}},"doesNotIntersectPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"}}}},"containsAllTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"}}}},"containsAnyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"}}}},"interval":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"}}}},"geoShapeV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"}}}},"startsWith":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Property"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyPropertyId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"},"type":{"type":"object","object":{"properties":{"minimumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maximumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappings":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappingsV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. An `interfaceToObjectTypeMappings` field is \noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\n\nThe `interfaceToObjectTypeMappings` field contains mappings from `SharedPropertyTypeApiName`s on the interface(s) to \n`PropertyApiName` for properties on the object(s).\n\nThe `interfaceToObjectTypeMappingsV2` field contains mappings from `InterfacePropertyApiName`s on the\ninterface(s) to `InterfacePropertyTypeImplementation` for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is\noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\nThe interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to\nPropertyApiName for properties on the object(s).\nThe interfaceToObjectTypeMappingsV2 field contains mappings from InterfacePropertyApiNames on the\ninterface(s) to InterfacePropertyTypeImplementation for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` \nmust be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either field or propertyIdentifier\nmust be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the struct parameter field.\n","plainTextDescription":"The unique identifier of the struct parameter field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds least of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds least of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"stringFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"}}}},"localizedFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.\n","plainTextDescription":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where at least one query is satisfied. An empty list matches no action types.","plainTextDescription":"Returns action types where at least one query is satisfied. An empty list matches no action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentMetadataResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"single":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}},"multiple":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The attachment metadata response","plainTextDescription":"The attachment metadata response","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"},"type":{"type":"object","object":{"properties":{"restrictedViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry restricted view.\n","plainTextDescription":"An object type datasource backed by a Foundry restricted view.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}},"filterLinkTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}}}},"safety":"SAFE","documentation":{"description":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.\n","plainTextDescription":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a direct-write source backing an object type.\n","plainTextDescription":"The RID of a direct-write source backing an object type.","example":["ri.ontology.main.direct-source.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the InterfacePropertyType.","plainTextDescription":"A short text that describes the InterfacePropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.\n","plainTextDescription":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"\n","plainTextDescription":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings required to access the property value. \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings required to access the property value.\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Performs both apply reducers and extract main value to return the reduced main value.","plainTextDescription":"Performs both apply reducers and extract main value to return the reduced main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"},"type":{"type":"object","object":{"properties":{"memberTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"},"type":{"type":"object","object":{"properties":{"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the main value of a struct as configured in the ontology.","plainTextDescription":"Returns the main value of a struct as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"},"type":{"type":"enum","enum":{"values":["PERCENTAGE","PER_MILLE","BASIS_POINTS"]}},"safety":"SAFE","documentation":{"description":"Ratio format options for displaying proportional values:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix\n","plainTextDescription":"Ratio format options for displaying proportional values:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"\n","plainTextDescription":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"","example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"\n","plainTextDescription":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"},"type":{"type":"object","object":{"properties":{"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\n`List object types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\nList object types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesV2Response"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponse"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the title property of an object type which is present on all object types.","plainTextDescription":"Specifies the title property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the sum of values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"},"type":{"type":"object","object":{"properties":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via the field of a local struct property.","plainTextDescription":"An implementation of an interface property via the field of a local struct property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSet"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"},"type":{"type":"enum","enum":{"values":["VALIDATE_ONLY","VALIDATE_AND_EXECUTE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `VALIDATE_AND_EXECUTE`.","plainTextDescription":"If not specified, defaults to VALIDATE_AND_EXECUTE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The current evaluation time itself. Carries no fields.","plainTextDescription":"The current evaluation time itself. Carries no fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"},"type":{"type":"object","object":{"properties":{"objects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Predefined localized formatting options.","plainTextDescription":"Predefined localized formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value.","plainTextDescription":"Returns objects where the specified field is greater than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"},"type":{"type":"object","object":{"properties":{"selectedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single link change between two objects.","plainTextDescription":"Represents a single link change between two objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series sync.","plainTextDescription":"The RID identifying a time series sync.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"}}}},"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"}}}},"editOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).\n","plainTextDescription":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"},"type":{"type":"enum","enum":{"values":["DAYS","HOURS","MINUTES","SECONDS","AUTO"]}},"safety":"SAFE","documentation":{"description":"Specifies the maximum precision to apply when formatting a duration.","plainTextDescription":"Specifies the maximum precision to apply when formatting a duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `oneOf` | The struct parameter field has a manually predefined set of options. |\n| `range` | The struct parameter field value must be within the defined range. |\n| `stringLength` | The struct parameter field value must have a length within the defined range. |\n| `stringRegexMatch` | The struct parameter field value must match a predefined regular expression. |\n| `objectQueryResult` | The struct parameter field value must be the primary key of an object found within an object set. |\n","plainTextDescription":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| oneOf | The struct parameter field has a manually predefined set of options. |\n| range | The struct parameter field value must be within the defined range. |\n| stringLength | The struct parameter field value must have a length within the defined range. |\n| stringRegexMatch | The struct parameter field value must match a predefined regular expression. |\n| objectQueryResult | The struct parameter field value must be the primary key of an object found within an object set. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified date or timestamp range.","plainTextDescription":"The parameter value must fall within the specified date or timestamp range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to local property).","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to local property).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"},"type":{"type":"object","object":{"properties":{"mainValueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The fields which comprise the main value of the struct.","plainTextDescription":"The fields which comprise the main value of the struct.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must have a length within the defined range.\n*This range is always inclusive.*\n","plainTextDescription":"The parameter value must have a length within the defined range.\nThis range is always inclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"},"type":{"type":"object","object":{"properties":{"linkId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}}}},"safety":"SAFE","documentation":{"description":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID. \nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.\n","plainTextDescription":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID.\nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Represents a unique identifier argument in a logic rule.","plainTextDescription":"Represents a unique identifier argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\n\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"}}}},"length":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"}}}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"}}}},"uuid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"}}}},"enum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"},"type":{"type":"enum","enum":{"values":["SECOND","MINUTE","HOUR","DAY","WEEK"]}},"safety":"SAFE","documentation":{"description":"Time unit for relative datetime offsets.","plainTextDescription":"Time unit for relative datetime offsets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains the provided value as a substring.","plainTextDescription":"Returns objects where the specified field contains the provided value as a substring.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property type that can be shared across object types.","plainTextDescription":"A property type that can be shared across object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'\n","plainTextDescription":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the primary key of an object found within an object set.\n","plainTextDescription":"The parameter value must be the primary key of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time range for a time series query.\n","plainTextDescription":"A relative time range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.\n","plainTextDescription":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which contain a logic rule of the given type.","plainTextDescription":"Returns action types which contain a logic rule of the given type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A user-specified alias for an aggregation metric name.","plainTextDescription":"A user-specified alias for an aggregation metric name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"},"type":{"type":"object","object":{"properties":{"entityType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object type or interface type API name.\n","plainTextDescription":"An object type or interface type API name.","example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts an object set to a specified object type or interface type API name. Any object whose object type does \nnot match the object type provided or implement the interface type provided will be dropped from the resulting \nobject set.\n","plainTextDescription":"Casts an object set to a specified object type or interface type API name. Any object whose object type does\nnot match the object type provided or implement the interface type provided will be dropped from the resulting\nobject set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on \nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRange"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The request to encrypt a plaintext value into a CipherText value.\n","plainTextDescription":"The request to encrypt a plaintext value into a CipherText value.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"definition":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The `definition` carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.\n","plainTextDescription":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The definition carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"},"type":{"type":"object","object":{"properties":{"conjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"disjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerConjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerDisjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"All marking requirements applicable to a property value.","plainTextDescription":"All marking requirements applicable to a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"},"type":{"type":"object","object":{"properties":{"ratioType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as a ratio with different scaling factors and suffixes:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")\n","plainTextDescription":"Display the value as a ratio with different scaling factors and suffixes:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"}}}},"createOrModifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"}}}},"batchedFunction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"}}}},"createOrModifyObjectV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"}}}},"deleteInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"}}}},"function":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}}},"createInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"}}}},"createInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A detailed operation for an Action","plainTextDescription":"A detailed operation for an Action","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have a notification.","plainTextDescription":"Returns action types based on whether they have a notification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in the following format.\n\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| [Attachment](/docs/foundry/api/v2/ontologies-v2-resources/attachment-properties/attachment-property-basics/) | JSON encoded `AttachmentProperty` object | `{\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"}` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` | \n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| Float | number | `3.14159265` |\n| GeoPoint | geojson | `{\"type\":\"Point\",\"coordinates\":[102.0,0.5]}` |\n| GeoShape | geojson | `{\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| [MediaReference](/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}}` |\n| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{\"value\": 10, \"propertySecurityIndex\" : 5}` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n| [Timeseries](/docs/foundry/api/v2/ontologies-v2-resources/time-series-properties/time-series-property-basics/) | JSON encoded `TimeseriesProperty` object or seriesId string | `{\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"}` or `{\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"}` or `\"wellPressureSeriesId\"`| |\n| Vector | array | `[0.1, 0.3, 0.02, 0.05 , 0.8, 0.4]` |\n\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.\n","plainTextDescription":"Represents the value of a property in the following format.\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | JSON encoded AttachmentProperty object | {\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"} |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| Float | number | 3.14159265 |\n| GeoPoint | geojson | {\"type\":\"Point\",\"coordinates\":[102.0,0.5]} |\n| GeoShape | geojson | {\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| MediaReference| JSON encoded MediaReference object | {\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}} |\n| Secured Property Value | JSON encoded SecuredPropertyValue object | {\"value\": 10, \"propertySecurityIndex\" : 5} |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |\n| Timeseries | JSON encoded TimeseriesProperty object or seriesId string | {\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"} or {\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"} or \"wellPressureSeriesId\"| |\n| Vector | array | [0.1, 0.3, 0.02, 0.05 , 0.8, 0.4] |\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"aggregate":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"searchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"}}}},"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"}}}},"intersect":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"}}}},"withProperties":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"}}}},"interfaceLinkSearchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"}}}},"nearestNeighbors":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"}}}},"asType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"}}}},"methodInput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"}}}},"filter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"}}}},"interfaceBase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"}}}},"asBaseObjectTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"}}}},"base":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the definition of an `ObjectSet` in the `Ontology`.","plainTextDescription":"Represents the definition of an ObjectSet in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"},"type":{"type":"object","object":{"properties":{"errors":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Arg"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"}}}},"removeLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"},"type":{"type":"object","object":{"properties":{"minimumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"applyReducersAndExtractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"}}}},"applyReducers":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"}}}},"extractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"}}}},"noLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The load level of the property:\n- APPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\n- EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\n- APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\n- NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.\n","plainTextDescription":"The load level of the property:\n\nAPPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\nEXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\nAPPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\nNO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"},"type":{"type":"object","object":{"properties":{"when":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.\n","plainTextDescription":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object parameter property argument in a logic rule.","plainTextDescription":"Represents an object parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The user's local timezone.","plainTextDescription":"The user's local timezone.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the interface type with the given rid.","plainTextDescription":"Returns action types which edit the interface type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.\n","plainTextDescription":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the link type with the given rid.","plainTextDescription":"Returns action types which edit the link type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"qos":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QosError"}}}},"success":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"},"type":{"type":"enum","enum":{"values":["EXPERIMENTAL","ACTIVE","DEPRECATED","EXAMPLE"]}},"safety":"SAFE","documentation":{"description":"Filter action types by status.","plainTextDescription":"Filter action types by status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Number of points in each window.","plainTextDescription":"Number of points in each window.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a column in a tabular datasource.","plainTextDescription":"The name of a column in a tabular datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Affix"},"type":{"type":"object","object":{"properties":{"prefix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"postfix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"An allowed configured value for a parameter within an action.","plainTextDescription":"An allowed configured value for a parameter within an action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.\n","plainTextDescription":"A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DecryptionResult"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value.","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatBasisPoints"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"\n","plainTextDescription":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Polygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Polygon"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the Geotime series.\n","plainTextDescription":"The set of properties that are bound to the Geotime series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.\n","plainTextDescription":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a static argument in a logic rule.","plainTextDescription":"Represents a static argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct list parameter field argument in a logic rule.","plainTextDescription":"Represents a struct list parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DataValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Attachment | string | `\"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` |\n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| EntrySet | array of JSON objects | `[{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}]` |\n| Float | number | `3.14159265` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| Marking | string | `\"MU\"` |\n| Null | null | `null` |\n| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z` |\n| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `\"EMP1234\"` |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| `{\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"}` |\n| Ontology Object Type Reference | string of the object type's api name | `\"Employee\"` |\n| Scenario Reference | string of the scenario RID | `\"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\"` |\n| Set | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object | `{\"name\": \"John Doe\", \"age\": 42}` |\n| TwoDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]}` |\n| ThreeDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]}` |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n","plainTextDescription":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | string | \"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\" |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| EntrySet | array of JSON objects | [{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}] |\n| Float | number | 3.14159265 |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| Marking | string | \"MU\" |\n| Null | null | null |\n| Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z |\n| Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or \"EMP1234\" |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| {\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"} |\n| Ontology Object Type Reference | string of the object type's api name | \"Employee\" |\n| Scenario Reference | string of the scenario RID | \"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\" |\n| Set | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object | {\"name\": \"John Doe\", \"age\": 42} |\n| TwoDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]} |\n| ThreeDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[".*fo?o*"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n - `.` matches any character.\n - `?` repeats the previous character 0 or 1 times.\n - `+` repeats the previous character 1 or more times.\n - `*` repeats the previous character 0 or more times.\n - `{}` defines the minimum and maximum number of times the preceding character can repeat. `{2}` means the\n previous character must repeat only twice, `{2,}` means the previous character must repeat at least twice,\n and `{2,4}` means the previous character must repeat between 2-4 times.\n - `|` is the OR operator.\n - `()` forms a group within an expression such that the group can be treated as a single character.\n - `[]` matches a single one of the characters contained inside the brackets, meaning [abc] matches `a`, `b` or\n `c`. Unless `-` is the first character or escaped with `\\` (in which case it is treated as a normal character),\n `-` can be used inside the bracket to create a range of characters, meaning [a-c] matches `a`, `b`, or `c`.\n If the character sequence inside the brackets begins with `^`, the set of characters is negated, meaning\n [^abc] does not match `a`, `b`, or `c`. Otherwise, `^` is treated as a normal character.\n - `\"` creates groups of string literals.\n - `\\` is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s \n and \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word \n characters respectively.\n\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n\n. matches any character.\n? repeats the previous character 0 or 1 times.\n+ repeats the previous character 1 or more times.\n* repeats the previous character 0 or more times.\n{} defines the minimum and maximum number of times the preceding character can repeat. {2} means the\nprevious character must repeat only twice, {2,} means the previous character must repeat at least twice,\nand {2,4} means the previous character must repeat between 2-4 times.\n| is the OR operator.\n() forms a group within an expression such that the group can be treated as a single character.\n[] matches a single one of the characters contained inside the brackets, meaning [abc] matches a, b or\nc. Unless - is the first character or escaped with \\ (in which case it is treated as a normal character),\n- can be used inside the bracket to create a range of characters, meaning [a-c] matches a, b, or c.\nIf the character sequence inside the brackets begins with ^, the set of characters is negated, meaning\n[^abc] does not match a, b, or c. Otherwise, ^ is treated as a normal character.\n\" creates groups of string literals.\n\\ is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s\nand \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word\ncharacters respectively.\n\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyVersion"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":["0000000d-2acf-537c-a228-3a9fe3cdc523"]}},{"locator":{"namespaceName":"Ontologies","localName":"QualifiedTimeseriesProperty"},"type":{"type":"object","object":{"properties":{"seriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"syncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by multiple time series syncs.","plainTextDescription":"The representation of a time series property backed by multiple time series syncs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}},"regex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","plainTextDescription":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Message returned when the value does not match the pattern.","plainTextDescription":"Message returned when the value does not match the pattern.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.\n","plainTextDescription":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"propertyMarkingSummary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"}}}},"unsupportedPolicy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"}}}},"errorComputingSecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.\n","plainTextDescription":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"},"type":{"type":"object","object":{"properties":{"datasetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Datasets","localName":"DatasetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry dataset.\n","plainTextDescription":"An object type datasource backed by a Foundry dataset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}},"scenarioRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"referenceSet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectLoadingResponseOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`branch` identifies the Foundry branch. `scenarioRid` identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, `branch` must identify that non-default base branch.\n","plainTextDescription":"branch identifies the Foundry branch. scenarioRid identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, branch must identify that non-default base branch.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the primary key value that is used as a unique identifier for an object.","plainTextDescription":"Represents the primary key value that is used as a unique identifier for an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}},"refresh":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"}}}},"updates":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Messages sent over the link type subscription WebSocket.","plainTextDescription":"Messages sent over the link type subscription WebSocket.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryOutputV2"},"type":{"type":"object","object":{"properties":{"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about the output of a query.","plainTextDescription":"Details about the output of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\n\nUse collectList or collectSet which will return a list of values in that case.\n","plainTextDescription":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\nUse collectList or collectSet which will return a list of values in that case.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A literal constraint value.","plainTextDescription":"A literal constraint value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A namespace for the type class.","plainTextDescription":"A namespace for the type class.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The value of the type class.","plainTextDescription":"The value of the type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Additional metadata that can be interpreted by user applications that interact with the Ontology\n","plainTextDescription":"Additional metadata that can be interpreted by user applications that interact with the Ontology","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.\n","plainTextDescription":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"},"type":{"type":"object","object":{"properties":{"signMediaReferences":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a `token` on each `MediaReference` value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\n\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.\n","plainTextDescription":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a token on each MediaReference value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Options for signing references in the response.","plainTextDescription":"Options for signing references in the response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field.","plainTextDescription":"Computes the approximate percentile value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deleteInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"}}}},"modifyInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"}}}},"createInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"},"type":{"type":"object","object":{"properties":{"regex":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The regular expression configured in the **Ontology Manager**.","plainTextDescription":"The regular expression configured in the Ontology Manager.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the **Ontology Manager**.\n","plainTextDescription":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must match a predefined regular expression.\n","plainTextDescription":"The parameter value must match a predefined regular expression.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given permission model.","plainTextDescription":"Returns action types with the given permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"},"type":{"type":"enum","enum":{"values":["START","END"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"entries":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","plainTextDescription":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a parameter ID argument in a logic rule.","plainTextDescription":"Represents a parameter ID argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"implementsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements.","plainTextDescription":"A list of interfaces that this object type implements.","example":[]}},"implementsInterfaces2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements and how it implements them.","plainTextDescription":"A list of interfaces that this object type implements and how it implements them.","example":[]}},"sharedPropertyTypeMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from shared property type API name to backing local property API name for the shared property types \npresent on this object type.\n","plainTextDescription":"A map from shared property type API name to backing local property API name for the shared property types\npresent on this object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"},"type":{"type":"object","object":{"properties":{"objectSetRidInputName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry restricted view.","plainTextDescription":"The RID of a Foundry restricted view.","example":["ri.foundry.main.restricted-view.8b2adf7c-ba8e-4d33-9bd7-46cc1c321ad4"]}},{"locator":{"namespaceName":"Ontologies","localName":"StringValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.\n","plainTextDescription":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsync","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RequestId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"Unique request id","plainTextDescription":"Unique request id","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenario"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"currentTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"}}}},"staticValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"}}}},"currentUser":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"}}}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"}}}},"interfaceParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"}}}},"synchronousWebhookOutput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"}}}},"objectParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"}}}},"uniqueIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.\n","plainTextDescription":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"},"type":{"type":"enum","enum":{"values":["STANDARD","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Currency rendering style options:\n- STANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\n- COMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")\n","plainTextDescription":"Currency rendering style options:\n\nSTANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\nCOMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value.","plainTextDescription":"Returns objects where the specified field is less than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Subtracts the right numeric value from the left numeric value.\n","plainTextDescription":"Subtracts the right numeric value from the left numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the `List interface types` endpoint and check the `allPropertiesV2` field or check\nthe **Ontology Manager**.\n","plainTextDescription":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the List interface types endpoint and check the allPropertiesV2 field or check\nthe Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QosError"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An error indicating that the subscribe request should be attempted on a different node.\n","plainTextDescription":"An error indicating that the subscribe request should be attempted on a different node.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"},"type":{"type":"object","object":{"properties":{"valueIfTrue":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is true","plainTextDescription":"Value to display if this boolean is true","example":[]}},"valueIfFalse":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is false","plainTextDescription":"Value to display if this boolean is false","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for boolean property values.","plainTextDescription":"Formatting configuration for boolean property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the object type with the given rid as an input or product.\n","plainTextDescription":"Returns action types which reference the object type with the given rid as an input or product.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.\n","plainTextDescription":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String or a double number.","plainTextDescription":"An object which is either an enum String or a double number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timestampFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"}}}},"operationIdsFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"description":"Map of the name of the derived property to return and its definition\n","plainTextDescription":"Map of the name of the derived property to return and its definition","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet which returns objects with additional derived properties.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which returns objects with additional derived properties.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"envelope":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}}},"geoJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.\n","plainTextDescription":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the object type.","plainTextDescription":"The API name of the object type.","example":["exampleAircraft"]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Ontology"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.\n","plainTextDescription":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series codex template that resolves to a derived series.","plainTextDescription":"The RID identifying a time series codex template that resolves to a derived series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns a single value of an array as configured in the ontology.","plainTextDescription":"Returns a single value of an array as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Calculates absolute value of a numeric value.\n","plainTextDescription":"Calculates absolute value of a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the object type with the given rid.","plainTextDescription":"Returns action types which edit the object type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides the left numeric value by the right numeric value.\n","plainTextDescription":"Divides the left numeric value by the right numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter expects an array of values and the size of the array must fall within the defined range.\n","plainTextDescription":"The parameter expects an array of values and the size of the array must fall within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"},"type":{"type":"object","object":{"properties":{"values":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".\n","plainTextDescription":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"},"type":{"type":"enum","enum":{"values":["ACTIVE","DEPRECATED"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given rid.","plainTextDescription":"Returns action types with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"TBD","plainTextDescription":"TBD","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"},"type":{"type":"enum","enum":{"values":["CEIL","FLOOR","ROUND_CLOSEST"]}},"safety":"SAFE","documentation":{"description":"Number rounding behavior:\n- CEIL: Always round up (3.1 becomes 4)\n- FLOOR: Always round down (3.9 becomes 3)\n- ROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)\n","plainTextDescription":"Number rounding behavior:\n\nCEIL: Always round up (3.1 becomes 4)\nFLOOR: Always round down (3.9 becomes 3)\nROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"alignmentTimestamp":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\n\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\n\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM, \neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.\n","plainTextDescription":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM,\neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.","example":[]}},"windowType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Aggregates values over discrete, periodic windows for a given time series.\n\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\n\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.\n","plainTextDescription":"Aggregates values over discrete, periodic windows for a given time series.\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.\n","plainTextDescription":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter must be omitted or empty.","plainTextDescription":"The parameter must be omitted or empty.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The response when loading entries from a geotemporal series reference property.\n\nEach entry in `data` is a map of property names to values containing the fields requested via\n`additionalProperties` in the corresponding `LoadGeotemporalSeriesRequest`. If `nextPageToken` is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.\n","plainTextDescription":"The response when loading entries from a geotemporal series reference property.\nEach entry in data is a map of property names to values containing the fields requested via\nadditionalProperties in the corresponding LoadGeotemporalSeriesRequest. If nextPageToken is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names that have been modified within the scenario.","plainTextDescription":"The list of link type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The link types that have been modified within a scenario.\n","plainTextDescription":"The link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditTypeFilter"},"type":{"type":"enum","enum":{"values":["create","modify","delete"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is in development.","plainTextDescription":"This status indicates that the PropertyType is in development.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"},"type":{"type":"enum","enum":{"values":["RUNNING_SUBMISSION_CHECKS","EXECUTING_WRITE_BACK_WEBHOOK","COMPUTING_ONTOLOGY_EDITS","COMPUTING_FUNCTION","WRITING_ONTOLOGY_EDITS","EXECUTING_SIDE_EFFECT_WEBHOOK","SENDING_NOTIFICATIONS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to \nspecify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, \nbut not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to\nspecify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,\nbut not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryRequest"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"filters":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sortOrder":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeAllPreviousProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of edits to return per page. Defaults to 100.","plainTextDescription":"The maximum number of edits to return per page. Defaults to 100.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request object for querying object type edits history, containing both filters and pagination parameters\n\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.\n","plainTextDescription":"Request object for querying object type edits history, containing both filters and pagination parameters\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"cause":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The subscription has been closed due to an irrecoverable error during its lifecycle.\n","plainTextDescription":"The subscription has been closed due to an irrecoverable error during its lifecycle.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface link type.","plainTextDescription":"The description of the interface link type.","example":[]}},"linkedEntityApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare at least one implementation of this link.\n","plainTextDescription":"Whether each implementing object type must declare at least one implementation of this link.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.\n","plainTextDescription":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface property type.","plainTextDescription":"The description of the interface property type.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypeRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface parameter property argument in a logic rule.","plainTextDescription":"Represents an interface parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinksResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of linked objects that have been edited within the scenario, grouped by source object.\n","plainTextDescription":"The list of linked objects that have been edited within the scenario, grouped by source object.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.\n","plainTextDescription":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the `List interface types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the List interface types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"now":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"}}}},"fixed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A datetime bound value.","plainTextDescription":"A datetime bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The ID identifying a transaction.","plainTextDescription":"The ID identifying a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via `PropertyWithLoadLevelSelector`) to opt a property out of a\n`defaultLoadLevel`.\n","plainTextDescription":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via PropertyWithLoadLevelSelector) to opt a property out of a\ndefaultLoadLevel.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.\n","plainTextDescription":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"auto":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"}}}},"off":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Fuzziness setting applied to `contains` full-text string predicates in the search query. If not provided,\n`auto` is used.\n","plainTextDescription":"Fuzziness setting applied to contains full-text string predicates in the search query. If not provided,\nauto is used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.\n","plainTextDescription":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.\n","plainTextDescription":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"},"type":{"type":"enum","enum":{"values":["newest_first","oldest_first"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"queryTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaMetadata"},"type":{"type":"object","object":{"properties":{"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Adds two or more numeric values.\n","plainTextDescription":"Adds two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}},"safety":"UNSAFE","documentation":{"example":[]}},"additionalProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.\n","plainTextDescription":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request body for loading entries from a geotemporal series reference property.\n\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as `OntologyObjectV2`.\n\nThe `range` field is required and restricts results to a specific time window. Both `startTime` and `endTime`\nare required on `range`. The `additionalProperties` field controls which additional properties appear in each\nreturned entry. Results are paginated; use `pageToken` from a previous response to retrieve additional pages.\n","plainTextDescription":"The request body for loading entries from a geotemporal series reference property.\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as OntologyObjectV2.\nThe range field is required and restricts results to a specific time window. Both startTime and endTime\nare required on range. The additionalProperties field controls which additional properties appear in each\nreturned entry. Results are paginated; use pageToken from a previous response to retrieve additional pages.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransaction"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Integer key for fixed value mapping.","plainTextDescription":"Integer key for fixed value mapping.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Query"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"By default, whenever an object is requested, all of its properties are returned, except for properties of the \nfollowing types:\n- Vector\n\nThe response can be filtered to only include certain properties using the `properties` query parameter. Note\nthat ontology object set endpoints refer to this parameter as `select`.\n\nProperties to include can be specified in one of two ways.\n\n- A comma delimited list as the value for the `properties` query parameter\n `properties={property1ApiName},{property2ApiName}`\n- Multiple `properties` query parameters.\n `properties={property1ApiName}&properties={property2ApiName}`\n\nThe primary key of the object will always be returned even if it wasn't specified in the `properties` values.\n\nUnknown properties specified in the `properties` list will result in a `PropertiesNotFound` error.\n\nTo find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"By default, whenever an object is requested, all of its properties are returned, except for properties of the\nfollowing types:\n\nVector\n\nThe response can be filtered to only include certain properties using the properties query parameter. Note\nthat ontology object set endpoints refer to this parameter as select.\nProperties to include can be specified in one of two ways.\n\nA comma delimited list as the value for the properties query parameter\nproperties={property1ApiName},{property2ApiName}\nMultiple properties query parameters.\nproperties={property1ApiName}&properties={property2ApiName}\n\nThe primary key of the object will always be returned even if it wasn't specified in the properties values.\nUnknown properties specified in the properties list will result in a PropertiesNotFound error.\nTo find the API name for your property, use the Get object type endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid RID (Resource Identifier).","plainTextDescription":"The string must be a valid RID (Resource Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"},"type":{"type":"object","object":{"properties":{"topLeft":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bottomRight":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The top left and bottom right coordinate points that make up the bounding box.\n","plainTextDescription":"The top left and bottom right coordinate points that make up the bounding box.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"},"type":{"type":"object","object":{"properties":{"operationIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"},"type":{"type":"object","object":{"properties":{"webhookOutputParamName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the webhook output parameter.","plainTextDescription":"The name of the webhook output parameter.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a synchronous webhook output argument in a logic rule.","plainTextDescription":"Represents a synchronous webhook output argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of \ntext fields. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of\ntext fields. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where every query is satisfied. An empty list matches all action types.","plainTextDescription":"Returns action types where every query is satisfied. An empty list matches all action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationObjectTypeGrouping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across \nmultiple object types, such as when aggregating over an interface type.\n","plainTextDescription":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across\nmultiple object types, such as when aggregating over an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"},"type":{"type":"enum","enum":{"values":["ASC","DESC"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"},"type":{"type":"object","object":{"properties":{"disjunction":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A disjunctive set of security results for a property value.\n","plainTextDescription":"A disjunctive set of security results for a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute datetime bound (ISO 8601 timestamp or date string).","plainTextDescription":"An absolute datetime bound (ISO 8601 timestamp or date string).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Indicates that the link types cannot be incrementally updated and must be refreshed.\n","plainTextDescription":"Indicates that the link types cannot be incrementally updated and must be refreshed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.\n","plainTextDescription":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"},"type":{"type":"enum","enum":{"values":["DAY","WEEK","MONTH","YEAR"]}},"safety":"SAFE","documentation":{"description":"Units for relative time calculations.","plainTextDescription":"Units for relative time calculations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"versionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must conform to the referenced value type.","plainTextDescription":"The parameter value must conform to the referenced value type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String, double number, or a geopoint.","plainTextDescription":"An object which is either an enum String, double number, or a geopoint.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.","plainTextDescription":"Divides objects into groups according to an exact value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"add":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"}}}},"absoluteValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"}}}},"extract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"}}}},"selection":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"}}}},"negate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"least":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"}}}},"divide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"}}}},"multiply":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"}}}},"greatest":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Definition of a derived property.\n","plainTextDescription":"Definition of a derived property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Duration"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"},"type":{"type":"object","object":{"properties":{"editedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Multiplies two or more numeric values.\n","plainTextDescription":"Multiplies two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"},"type":{"type":"object","object":{"properties":{"wrappedType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique id of a geotime series (track) associated with a GTSR.","plainTextDescription":"The unique id of a geotime series (track) associated with a GTSR.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `kind` attribute of a type class.","plainTextDescription":"Exact match predicate for the kind attribute of a type class.","example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `name` attribute of a type class.","plainTextDescription":"Exact match predicate for the name attribute of a type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching type classes. Matches a type class when `kind`, and `name` if provided, match the\ncorresponding attribute of the type class. If `name` is empty, only `kind` is required to match. You can\nsearch for both parameter type classes and action type type classes.\n","plainTextDescription":"A predicate for matching type classes. Matches a type class when kind, and name if provided, match the\ncorresponding attribute of the type class. If name is empty, only kind is required to match. You can\nsearch for both parameter type classes and action type type classes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names scoped by the object type.","plainTextDescription":"The list of link type API names scoped by the object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.\n","plainTextDescription":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Attachment"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation ranges.\n","plainTextDescription":"A union of all the types supported by query aggregation ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","plainTextDescription":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"The magnitude of a relative datetime offset.","plainTextDescription":"The magnitude of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsMultipleObjectTypes` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an ontology scenario.","plainTextDescription":"The unique resource identifier of an ontology scenario.","example":["ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"},"type":{"type":"object","object":{"properties":{"tableRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TableRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry table.","plainTextDescription":"An object type datasource backed by a Foundry table.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsRequest"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for staging edits to a transaction.","plainTextDescription":"The request payload for staging edits to a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Duration"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 formatted duration.","plainTextDescription":"An ISO 8601 formatted duration.","example":["PT15M"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"},"type":{"type":"object","object":{"properties":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"}}}},"datetime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"}}}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"}}}},"markdown":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"}}}},"mustBeEmpty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The allowed-values constraint configured on an action parameter.","plainTextDescription":"The allowed-values constraint configured on an action parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"},"type":{"type":"object","object":{"properties":{"implementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via applying reducers on the nested implementation.","plainTextDescription":"An implementation of an interface property via applying reducers on the nested implementation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"An override value to be used for a UniqueIdentifier action parameter, instead of \nthe value being automatically generated.\n","plainTextDescription":"An override value to be used for a UniqueIdentifier action parameter, instead of\nthe value being automatically generated.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"}}},"safety":"SAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided, \nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Reason"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.","plainTextDescription":"Divides objects into groups with the specified width.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioConflictingObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have a conflicting edit within the scenario.","plainTextDescription":"The list of objects that have a conflicting edit within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have a conflicting edit within a scenario for a given object type.","plainTextDescription":"The objects that have a conflicting edit within a scenario for a given object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Affix"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"\n","plainTextDescription":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"webhookRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"}}}},"hasActionLog":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"}}}},"actionTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"}}}},"permissionModel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"}}}},"hasWebhook":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"}}}},"actionTypeDisplayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"}}}},"affectedLinkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"}}}},"actionTypeDescription":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"}}}},"sectionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"}}}},"parameterRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"}}}},"parameterName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"}}}},"hasNotification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"}}}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"}}}},"inputObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"}}}},"revertActionEnabled":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"}}}},"logicRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"}}}},"typeClasses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"}}}},"affectedInterfaceTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"}}}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"}}}},"affectedObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"}}}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the search query for an action type search. Supports filters for various action type features.\n","plainTextDescription":"Represents the search query for an action type search. Supports filters for various action type features.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the average value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"},"type":{"type":"enum","enum":{"values":["BEFORE","AFTER"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a struct parameter's fields against the configured constraints.","plainTextDescription":"Represents the validity of a struct parameter's fields against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.","plainTextDescription":"Divides objects into groups according to specified ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"},"type":{"type":"object","object":{"properties":{"unionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.\n","plainTextDescription":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"interfaceDefinedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"}}}},"interfaceSharedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.\n","plainTextDescription":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"toolDescription":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Optional description intended for tool use contexts, such as AI agents.","plainTextDescription":"Optional description intended for tool use contexts, such as AI agents.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end date.","plainTextDescription":"Exclusive end date.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive end date.","plainTextDescription":"Inclusive end date.","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive start date.","plainTextDescription":"Exclusive start date.","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start date.","plainTextDescription":"Inclusive start date.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a date range from an inclusive start date to an exclusive end date.","plainTextDescription":"Specifies a date range from an inclusive start date to an exclusive end date.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"pluralDisplayName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The plural display name of the object type.","plainTextDescription":"The plural display name of the object type.","example":[]}},"icon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Icon"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"aliases":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. `getObjectTypeV2`); it is always empty on the `listObjectTypesV2` endpoint.\n","plainTextDescription":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. getObjectTypeV2); it is always empty on the listObjectTypesV2 endpoint.","example":[]}},"datasources":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"}}}}},"safety":"UNSAFE","documentation":{"description":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies `includeDatasources=true`. This list may be empty if the user doesn't have access to any\ndatasources.\n","plainTextDescription":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies includeDatasources=true. This list may be empty if the user doesn't have access to any\ndatasources.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"description":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\n\nEach object type's `linkTypes` is only populated when the request specifies\n`includeLinkTypes=true`, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.\n","plainTextDescription":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\nEach object type's linkTypes is only populated when the request specifies\nincludeLinkTypes=true, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectSetChanged":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"}}}},"refreshObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"}}}},"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"},"type":{"type":"object","object":{"properties":{"includesAllPreviousValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.\n","plainTextDescription":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"geometry":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"}}},"safety":"UNSAFE","documentation":{"example":[]}},"spatialFilterMode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager**\napplication.\n","plainTextDescription":"The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager\napplication.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given status.","plainTextDescription":"Returns action types with the given status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an attachment.","plainTextDescription":"The unique resource identifier of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"},"type":{"type":"object","object":{"properties":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the `fields` array is provided, `orderType` is automatically set to `fields`.\nIf this object is omitted entirely, the ordering is unspecified.\n\nSetting `orderType` to `relevance` requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. `containsAllTerms`, `containsAnyTerm`,\n`containsAllTermsInOrder`, `containsAllTermsInOrderPrefixLastTerm`) or `nearestNeighbors`, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\n\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\n\nRelevance ordering can be expensive and should only be used when required.\n","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the fields array is provided, orderType is automatically set to fields.\nIf this object is omitted entirely, the ordering is unspecified.\nSetting orderType to relevance requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. containsAllTerms, containsAnyTerm,\ncontainsAllTermsInOrder, containsAllTermsInOrderPrefixLastTerm) or nearestNeighbors, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\nRelevance ordering can be expensive and should only be used when required.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"},"type":{"type":"object","object":{"properties":{"showFullUnits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to show full or abbreviated time units.","plainTextDescription":"Whether to show full or abbreviated time units.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formats the duration as a human-readable written string.","plainTextDescription":"Formats the duration as a human-readable written string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"},"type":{"type":"object","object":{"properties":{"zoneId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"},"type":{"type":"enum","enum":{"values":["fields","relevance"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"}}}},"get":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"}}}},"collectList":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"}}}},"collectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property\n","plainTextDescription":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"},"type":{"type":"object","object":{"properties":{"defaultValidation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation metadata surfaced for a parameter.","plainTextDescription":"Validation metadata surfaced for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from the backing column struct field names to a struct property's fields.\n","plainTextDescription":"A mapping from the backing column struct field names to a struct property's fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the maximum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for date property values.","plainTextDescription":"Formatting configuration for date property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a display name matching the given string predicate.","plainTextDescription":"Returns action types with a display name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"},"type":{"type":"enum","enum":{"values":["SUM","MEAN","STANDARD_DEVIATION","MAX","MIN","PERCENT_CHANGE","DIFFERENCE","PRODUCT","COUNT","FIRST","LAST"]}},"safety":"SAFE","documentation":{"description":"The aggregation function to use for aggregating time series data.\n","plainTextDescription":"The aggregation function to use for aggregating time series data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to specified ranges.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyObjectTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","plainTextDescription":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Property"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"},"type":{"type":"object","object":{"properties":{"term":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The term to match.","plainTextDescription":"The term to match.","example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.\n","plainTextDescription":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.\n","plainTextDescription":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier (ID) for an object type. This can be viewed in [Ontology Manager](/docs/foundry/ontology-manager/overview/).","plainTextDescription":"The unique identifier (ID) for an object type. This can be viewed in Ontology Manager.","example":["example-aircraft"]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioResponse"},"type":{"type":"object","object":{"properties":{"scenarioRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The response payload for creating an ontology scenario.","plainTextDescription":"The response payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}}},"pointsCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\n\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.\n","plainTextDescription":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"},"type":{"type":"object","object":{"properties":{"typeId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to a type that is defined in the `typeReferences` map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.\n","plainTextDescription":"A reference to a type that is defined in the typeReferences map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"},"type":{"type":"object","object":{"properties":{"uniqueIdentifierLinkIdValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"}}}}},"safety":"SAFE","documentation":{"example":[]}},"actionExecutionTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"},"type":{"type":"object","object":{"properties":{"scaleType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n- THOUSANDS: 1500 displays as \"1.5K\"\n- MILLIONS: 2500000 displays as \"2.5M\"\n- BILLIONS: 3200000000 displays as \"3.2B\"\n","plainTextDescription":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n\nTHOUSANDS: 1500 displays as \"1.5K\"\nMILLIONS: 2500000 displays as \"2.5M\"\nBILLIONS: 3200000000 displays as \"3.2B\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings representing the same sequence of characters as the given string.","plainTextDescription":"Matches strings representing the same sequence of characters as the given string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"},"type":{"type":"enum","enum":{"values":["actionTypeDisplayName"]}},"safety":"SAFE","documentation":{"description":"Specifies the field to sort action types by.","plainTextDescription":"Specifies the field to sort action types by.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"},"type":{"type":"object","object":{"properties":{"maxSizeBytes":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","plainTextDescription":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property filter. For instance, false is the FilterValue in\n`properties.{propertyApiName}.isNull=false`.\n","plainTextDescription":"Represents the value of a property filter. For instance, false is the FilterValue in\nproperties.{propertyApiName}.isNull=false.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"request":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkState"},"type":{"type":"enum","enum":{"values":["ADDED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.\n","plainTextDescription":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsOrInterfaces` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingInterfaceLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface link types in the current page.","plainTextDescription":"The list of interface link types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"},"type":{"type":"enum","enum":{"values":["INTERSECTS","DISJOINT","WITHIN","CONTAINS"]}},"safety":"SAFE","documentation":{"description":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.\n","plainTextDescription":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"},"type":{"type":"object","object":{"properties":{"geoJson":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.\n","plainTextDescription":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry specification.","plainTextDescription":"A GeoJSON geometry specification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version of the given Function, written `..-`, where `-` is optional.\nExamples: `1.2.3`, `1.2.3-rc1`.\n","plainTextDescription":"The version of the given Function, written ..-, where - is optional.\nExamples: 1.2.3, 1.2.3-rc1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.\n","plainTextDescription":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a parameter matching the given parameter rid.","plainTextDescription":"Returns action types with a parameter matching the given parameter rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"relativePoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a bound for a relative date range query.","plainTextDescription":"Specifies a bound for a relative date range query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the primary key property of an object type which is present on all object types.","plainTextDescription":"Specifies the primary key property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"}}}},"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked entity. This can either be an object or an interface type.","plainTextDescription":"A reference to the linked entity. This can either be an object or an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Definition for a selected property over a MethodObjectSet.","plainTextDescription":"Definition for a selected property over a MethodObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the **Ontology Manager**.\n","plainTextDescription":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of directed link type API names.","plainTextDescription":"A list of directed link type API names.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface.","plainTextDescription":"The description of the interface.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"allProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has, including properties from all directly and indirectly extended \ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has, including properties from all directly and indirectly extended\ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.","example":[]}},"allPropertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.","example":[]}},"extendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n","plainTextDescription":"A list of interface API names that this interface extends. An interface can extend other interfaces to\ninherit their properties.","example":[]}},"allExtendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends, both directly and indirectly.\n","plainTextDescription":"A list of interface API names that this interface extends, both directly and indirectly.","example":[]}},"implementedByObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object API names that implement this interface.\n","plainTextDescription":"A list of object API names that implement this interface.","example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.","example":[]}},"allLinks":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface type in the Ontology.","plainTextDescription":"Represents an interface type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier for an action.","plainTextDescription":"The unique resource identifier for an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"},"type":{"type":"enum","enum":{"values":["ADD_OBJECT","MODIFY_OBJECT","DELETE_OBJECT","ADD_LINK","DELETE_LINK","FUNCTION","BATCHED_FUNCTION","ADD_OR_MODIFY_OBJECT","ADD_OR_MODIFY_OBJECT_V2"]}},"safety":"SAFE","documentation":{"description":"Filter action types by the type of logic rule they contain.","plainTextDescription":"Filter action types by the type of logic rule they contain.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterface"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"deadline":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"example":[]}},"replacedBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.\n","plainTextDescription":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a link type. To find the ID for your link type, check the **Ontology Manager** application.\n","plainTextDescription":"The unique ID of a link type. To find the ID for your link type, check the Ontology Manager application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the \n[Ontology Manager](/docs/foundry/ontology-manager/overview/).\n","plainTextDescription":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the\nOntology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"},"type":{"type":"object","object":{"properties":{"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating one of the **submission criteria** was not satisfied.\nThis is configured per **submission criteria** in the **Ontology Manager**.\n","plainTextDescription":"The message indicating one of the submission criteria was not satisfied.\nThis is configured per submission criteria in the Ontology Manager.","example":[]}},"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Contains the status of the **submission criteria**.\n**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the **Ontology Manager**.\n","plainTextDescription":"Contains the status of the submission criteria.\nSubmission criteria are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherTextProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"part":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts the specified date part from a date or timestamp.\n","plainTextDescription":"Extracts the specified date part from a date or timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"dateValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DateValue"}}}},"stringValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringValue"}}}},"timestampValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"}}}},"booleanValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"}}}},"integerValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"}}}},"doubleValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"}}}},"longValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LongValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property api name that references properties to query on.","plainTextDescription":"A property api name that references properties to query on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have an action log.","plainTextDescription":"Returns action types based on whether they have an action log.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"geopoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoPointType"}}}},"geotimeSeriesReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeotimeSeriesReferenceType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"timeseries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimeseriesType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Object properties.\n","plainTextDescription":"A union of all the types supported by Ontology Object properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Formats the duration in a timecode format.","plainTextDescription":"Formats the duration in a timecode format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operationId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The user ID or principal that performed the action","plainTextDescription":"The user ID or principal that performed the action","example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"When this edit occurred (ISO 8601 format)","plainTextDescription":"When this edit occurred (ISO 8601 format)","example":[]}},"edit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.\n","plainTextDescription":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action.","plainTextDescription":"Details about a parameter of an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesFullMetadataResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamingOutputFormat"},"type":{"type":"enum","enum":{"values":["JSON","ARROW"]}},"safety":"SAFE","documentation":{"description":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.\n","plainTextDescription":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsForInterfaceResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface instances in the current page.","plainTextDescription":"The list of interface instances in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The source of a constraint bound value.","plainTextDescription":"The source of a constraint bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"optional":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API.\n","plainTextDescription":"The name of the Query in the API.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"},"type":{"type":"object","object":{"properties":{"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"KnownType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formatting configuration for known Foundry types.","plainTextDescription":"Formatting configuration for known Foundry types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueType"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. |\n| Attachment | `Attachment` |\n| Boolean | `Boolean` |\n| Byte | `Byte` |\n| CipherText | `CipherText` |\n| Date | `LocalDate` |\n| Decimal | `Decimal` |\n| Double | `Double` |\n| Float | `Float` |\n| Integer | `Integer` |\n| Long | `Long` |\n| Marking | `Marking` |\n| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. |\n| Short | `Short` |\n| String | `String` |\n| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` |\n| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. |\n| Timestamp | `Timestamp` |\n","plainTextDescription":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | Array, where T is the type of the array elements, e.g. Array. |\n| Attachment | Attachment |\n| Boolean | Boolean |\n| Byte | Byte |\n| CipherText | CipherText |\n| Date | LocalDate |\n| Decimal | Decimal |\n| Double | Double |\n| Float | Float |\n| Integer | Integer |\n| Long | Long |\n| Marking | Marking |\n| OntologyObject | OntologyObject where T is the API name of the referenced object type. |\n| Short | Short |\n| String | String |\n| Struct | Struct where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> |\n| Timeseries | TimeSeries where T is either String for an enum series or Double for a numeric series. |\n| Timestamp | Timestamp |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked interface type.","plainTextDescription":"A reference to the linked interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Error"},"type":{"type":"object","object":{"properties":{"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"}}},"safety":"SAFE","documentation":{"example":[]}},"args":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Arg"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry stream.","plainTextDescription":"The RID of a Foundry stream.","example":["ri.foundry.main.stream.f7e91c94-1cb2-4e34-8fdb-3da7c1a91e8b"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.\n","plainTextDescription":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"rid","rid":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current user argument in a logic rule.","plainTextDescription":"Represents the current user argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CustomTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A UUID representing a custom type in a given Function.\n","plainTextDescription":"A UUID representing a custom type in a given Function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a description matching the given string predicate.","plainTextDescription":"Returns action types with a description matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedEntityTypesResponse"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of edited link types grouped by source object type.\n\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.\n","plainTextDescription":"The list of edited link types grouped by source object type.\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types and link types that have been modified within a scenario.\n","plainTextDescription":"The object types and link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedTimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"templateRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"}}},"safety":"SAFE","documentation":{"example":[]}},"templateVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by a derived time series calculated with a formula.","plainTextDescription":"The representation of a time series property backed by a derived time series calculated with a formula.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"constraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS","QUARTERS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.\n","plainTextDescription":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a property.","plainTextDescription":"The unique resource identifier of a property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"partialMatch":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a classification or mandatory marking.","plainTextDescription":"The id of a classification or mandatory marking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which use the function with the given rid.","plainTextDescription":"Returns action types which use the function with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequest"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"query":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationV2"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsyncV2","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field.","plainTextDescription":"Returns objects based on the existence of the specified field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"}}}},"number":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"}}}},"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces. \nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\n\nEach formatter type provides specific options tailored to that data type:\n- Numbers: Support for percentages, currencies, units, scaling, and custom formatting\n- Dates/Timestamps: Localized and custom formatting patterns\n- Booleans: Custom true/false display text\n- Known types: Special formatting for Foundry-specific identifiers\n","plainTextDescription":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces.\nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\nEach formatter type provides specific options tailored to that data type:\n\nNumbers: Support for percentages, currencies, units, scaling, and custom formatting\nDates/Timestamps: Localized and custom formatting patterns\nBooleans: Custom true/false display text\nKnown types: Special formatting for Foundry-specific identifiers","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"},"type":{"type":"enum","enum":{"values":["DATASOURCE_DERIVED_PERMISSIONS","ONTOLOGY_ROLES","COMPASS_PROJECT"]}},"safety":"SAFE","documentation":{"description":"Filter action types by permission model.","plainTextDescription":"Filter action types by permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaReferenceProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched terms must occur in order.","plainTextDescription":"If true, the matched terms must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing the terms in the query\n","plainTextDescription":"Matches intervals containing the terms in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter.","plainTextDescription":"A possible value for the parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DateValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"date","date":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in string format. This is used in URL parameters.","plainTextDescription":"Represents the value of a property in string format. This is used in URL parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"},"type":{"type":"enum","enum":{"values":["USER_CLOSED","CHANNEL_CLOSED"]}},"safety":"SAFE","documentation":{"description":"Represents the reason a subscription was closed.\n","plainTextDescription":"Represents the reason a subscription was closed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the server was not able to load the securities of the property.","plainTextDescription":"Indicates the server was not able to load the securities of the property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current Page.","plainTextDescription":"The list of objects in the current Page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`.","plainTextDescription":"Represents the API response when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"constant":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"}}}},"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentProperty"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The representation of an attachment as a data type.","plainTextDescription":"The representation of an attachment as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager**\napplication and assign them API names. In every other case, API names should be used instead of property IDs.\n","plainTextDescription":"The immutable ID of a property. Property IDs are only used to identify properties in the Ontology Manager\napplication and assign them API names. In every other case, API names should be used instead of property IDs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The base used to initialize a scenario.","plainTextDescription":"The base used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"any":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AnyType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the primitive types used by Palantir's Ontology-based products.\n","plainTextDescription":"A union of all the primitive types used by Palantir's Ontology-based products.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"}}}}},"safety":"UNSAFE","documentation":{"description":"List of historical edits for this object type","plainTextDescription":"List of historical edits for this object type","example":[]}},"totalCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Count of items in the data array above","plainTextDescription":"Count of items in the data array above","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.\n","plainTextDescription":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"},"type":{"type":"object","object":{"properties":{"color":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A hexadecimal color code.","plainTextDescription":"A hexadecimal color code.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. \nUsed to specify the Blueprint icon to represent the object type in a React app.\n","plainTextDescription":"The name of the Blueprint icon.\nUsed to specify the Blueprint icon to represent the object type in a React app.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"reducers":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"}}}}},"safety":"UNSAFE","documentation":{"description":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.\n","plainTextDescription":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the struct type to the value type applied to that property.","plainTextDescription":"A map of the properties of the struct type to the value type applied to that property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A valid format string composed of date/time patterns.","plainTextDescription":"A valid format string composed of date/time patterns.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A strictly specified date format pattern.","plainTextDescription":"A strictly specified date format pattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"transactionId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"absolute":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute or relative range for a time series query.","plainTextDescription":"An absolute or relative range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"},"type":{"type":"object","object":{"properties":{"mapping":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be a property value of an object found within an object set.\n","plainTextDescription":"The parameter value must be a property value of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LongValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.\n","plainTextDescription":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"},"type":{"type":"object","object":{"properties":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A branch reference used to initialize a scenario.","plainTextDescription":"A branch reference used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"description":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.\n","plainTextDescription":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["fo*o"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the wildcard pattern provided.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the wildcard pattern provided.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Action"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"standard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"}}}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"}}}},"fixedValues":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"}}}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"}}}},"scale":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"}}}},"currency":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"}}}},"standardUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"}}}},"customUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"}}}},"ratio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToDelete":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}},"includeLinkTypes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all outgoing link types for each requested object type in that object type's\n`linkTypes`. When false or omitted, `linkTypes` is empty.\n","plainTextDescription":"A flag that will return all outgoing link types for each requested object type in that object type's\nlinkTypes. When false or omitted, linkTypes is empty.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"},"type":{"type":"object","object":{"properties":{"interfaceType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object set with objects that implement the interface with the given interface API name. The objects in \nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.\n","plainTextDescription":"An object set with objects that implement the interface with the given interface API name. The objects in\nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.","example":[]}},"includeAllBaseObjectProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all of the underlying object properties for the objects that implement the interface. \nThis includes properties that don't explicitly implement an SPT on the interface.\n","plainTextDescription":"A flag that will return all of the underlying object properties for the objects that implement the interface.\nThis includes properties that don't explicitly implement an SPT on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"},"type":{"type":"object","object":{"properties":{"direction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"}}},"safety":"SAFE","documentation":{"example":[]}},"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"},"type":{"type":"enum","enum":{"values":["ADDED_OR_UPDATED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was \nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object \nwas removed from the set due to the object being deleted or the object no longer meets the object set \ndefinition.\n","plainTextDescription":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was\nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object\nwas removed from the set due to the object being deleted or the object no longer meets the object set\ndefinition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a geotime integration.","plainTextDescription":"The unique resource identifier of a geotime integration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SecuredPropertyValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertySecurityIndex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.\n","plainTextDescription":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationOrderBy"},"type":{"type":"object","object":{"properties":{"metricName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds greatest of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds greatest of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.\n","plainTextDescription":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"geotimeSeriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a geotime series integration as a data type.","plainTextDescription":"The representation of a geotime series integration as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name or RID of the Ontology. To find the API name or RID, use the **List Ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or\ncheck the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"},"type":{"type":"enum","enum":{"values":["REQUIRE_ACCURATE","ALLOW_APPROXIMATE"]}},"safety":"SAFE","documentation":{"description":"Specifies the accuracy requirement for aggregation results.\n\n- `REQUIRE_ACCURATE`: Only return results if they are guaranteed to be accurate. If accuracy cannot be\n guaranteed (e.g., due to a low `maxGroupCount` relative to distinct values), the request will fail\n with an `AggregationAccuracyNotSupported` error.\n- `ALLOW_APPROXIMATE`: Allow approximate results when exact computation is not feasible. This is the\n default behavior if not specified.\n","plainTextDescription":"Specifies the accuracy requirement for aggregation results.\n\nREQUIRE_ACCURATE: Only return results if they are guaranteed to be accurate. If accuracy cannot be\nguaranteed (e.g., due to a low maxGroupCount relative to distinct values), the request will fail\nwith an AggregationAccuracyNotSupported error.\nALLOW_APPROXIMATE: Allow approximate results when exact computation is not feasible. This is the\ndefault behavior if not specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value.","plainTextDescription":"Returns objects where the specified field is less than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"},"type":{"type":"object","object":{"properties":{"ciphertext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CipherText"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.","example":[{"ciphertext":"CIPHER::ri.bellaso.main.cipher-channel.x::::CIPHER"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the `typeReferences` map of the enclosing Query.\n","plainTextDescription":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the typeReferences map of the enclosing Query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"},"type":{"type":"object","object":{"properties":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the media view.\n","plainTextDescription":"The set of properties that are bound to the media view.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.\n","plainTextDescription":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"},"type":{"type":"object","object":{"properties":{"sourceObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsForInterfaceRequest"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"augmentedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from object type API name to a list of property type API names. For each returned object, if the \nobject’s object type is a key in the map, then we augment the response for that object type with the list \nof properties specified in the value.\n","plainTextDescription":"A map from object type API name to a list of property type API names. For each returned object, if the\nobject’s object type is a key in the map, then we augment the response for that object type with the list\nof properties specified in the value.","example":[]}},"augmentedSharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"augmentedInterfacePropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of interface property type API names. For each returned object, \nif the object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of interface property type API names. For each returned object,\nif the object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"selectedSharedPropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of shared property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of shared property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedInterfacePropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of interface property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the \nparameter to include all object types.\n","plainTextDescription":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the\nparameter to include all object types.","example":[]}},"otherInterfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be \nincluded in the response.\n","plainTextDescription":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be\nincluded in the response.","example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"},"type":{"type":"enum","enum":{"values":["VALID","INVALID"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a validation.\n","plainTextDescription":"Represents the state of a validation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"},"type":{"type":"object","object":{"properties":{"targetObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe `targetObject` Ontology Object in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe targetObject Ontology Object in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"KnownType"},"type":{"type":"enum","enum":{"values":["USER_OR_GROUP_ID","RESOURCE_RID","ARTIFACT_GID"]}},"safety":"SAFE","documentation":{"description":"Known Foundry types for specialized formatting:\n- userOrGroupRid: Format as user or group\n- resourceRid: Format as resource \n- artifactGid: Format as artifact\n","plainTextDescription":"Known Foundry types for specialized formatting:\n\nuserOrGroupRid: Format as user or group\nresourceRid: Format as resource\nartifactGid: Format as artifact","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they reference a webhook.","plainTextDescription":"Returns action types based on whether they reference a webhook.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"},"type":{"type":"object","object":{"properties":{"method":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"}}},"safety":"SAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct parameter field argument in a logic rule.","plainTextDescription":"Represents a struct parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"},"type":{"type":"object","object":{"properties":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionInputValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"}}}}},"safety":"UNSAFE","documentation":{"description":"The predefined set of options.","plainTextDescription":"The predefined set of options.","example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether values outside `options` are allowed.","plainTextDescription":"Whether values outside options are allowed.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be one of a fixed set of labelled options.","plainTextDescription":"The parameter value must be one of a fixed set of labelled options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo"]}}}}},"safety":"UNSAFE","documentation":{"description":"Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`, which is preferred because the name `startsWith` is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via a local property.","plainTextDescription":"An implementation of an interface property via a local property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"link":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of groups to return. If omitted, defaults to 10,000.\n\nThe server allocates resources based on the specified `maxGroupCount`. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\n\nIf you need accurate results with high-cardinality properties, set `maxGroupCount` high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\n`excludedItems`. The response `accuracy` field indicates whether the results are `ACCURATE` or\n`APPROXIMATE`.\n","plainTextDescription":"The maximum number of groups to return. If omitted, defaults to 10,000.\nThe server allocates resources based on the specified maxGroupCount. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\nIf you need accurate results with high-cardinality properties, set maxGroupCount high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\nexcludedItems. The response accuracy field indicates whether the results are ACCURATE or\nAPPROXIMATE.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.\n","plainTextDescription":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.","example":[]}},"includeNullValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.\n","plainTextDescription":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an exact value.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"},"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"An ISO 8601 timestamp.\n","plainTextDescription":"An ISO 8601 timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value.","plainTextDescription":"Returns objects where the specified array contains a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"ObjectSet which is the root of a MethodObjectSet definition.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which is the root of a MethodObjectSet definition.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter` of type\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter of type\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types whose type class satisfies the given type class predicate.","plainTextDescription":"Returns action types whose type class satisfies the given type class predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"},"type":{"type":"object","object":{"properties":{"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique codex id of a time series.","plainTextDescription":"The unique codex id of a time series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deprecated":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"}}}},"active":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"}}}},"experimental":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"}}}},"example":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.\n","plainTextDescription":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}},"reducedPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property.\n","plainTextDescription":"Describes how an object type implements an interface property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"\n","plainTextDescription":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The duration value.","plainTextDescription":"The duration value.","example":[30]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A measurement of duration.","plainTextDescription":"A measurement of duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"},"type":{"type":"enum","enum":{"values":["THOUSANDS","MILLIONS","BILLIONS"]}},"safety":"SAFE","documentation":{"description":"Scale factor options for large numbers:\n- THOUSANDS: Divide by 1,000 and add \"K\" suffix\n- MILLIONS: Divide by 1,000,000 and add \"M\" suffix\n- BILLIONS: Divide by 1,000,000,000 and add \"B\" suffix\n","plainTextDescription":"Scale factor options for large numbers:\n\nTHOUSANDS: Divide by 1,000 and add \"K\" suffix\nMILLIONS: Divide by 1,000,000 and add \"M\" suffix\nBILLIONS: Divide by 1,000,000,000 and add \"B\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A unique identifier used to associate subscription requests with responses.","plainTextDescription":"A unique identifier used to associate subscription requests with responses.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"createEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"}}}},"deleteEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"}}}},"modifyEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching strings.","plainTextDescription":"A predicate for matching strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"},"type":{"type":"object","object":{"properties":{"allowedValues":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"arraySize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation constraints for a parameter.","plainTextDescription":"Validation constraints for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a section matching the given section rid.","plainTextDescription":"Returns action types with a section matching the given section rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"},"type":{"type":"object","object":{"properties":{"unsupportedType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A short, stable discriminator naming the underlying OMS variant. E.g., `\"derivedProperties\"` for\nderived-properties datasources or `\"unknown\"` for variants the adapter does not recognize.\n","plainTextDescription":"A short, stable discriminator naming the underlying OMS variant. E.g., \"derivedProperties\" for\nderived-properties datasources or \"unknown\" for variants the adapter does not recognize.","example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The property API names that this datasource backs.","plainTextDescription":"The property API names that this datasource backs.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource of a kind not yet exposed in the public API. The `unsupportedType` discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an `\"unknown\"` discriminator. The `properties` list\nenumerates the property API names this datasource backs. The `properties` will be empty for `\"unknown\"`\ndatasources.\n","plainTextDescription":"A datasource of a kind not yet exposed in the public API. The unsupportedType discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an \"unknown\" discriminator. The properties list\nenumerates the property API names this datasource backs. The properties will be empty for \"unknown\"\ndatasources.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"},"type":{"type":"enum","enum":{"values":["FUTURE","PAST"]}},"safety":"SAFE","documentation":{"description":"Direction of a relative datetime offset.","plainTextDescription":"Direction of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structListParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"}}}},"structParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument used for an individual struct field.\n","plainTextDescription":"Represents an argument used for an individual struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by `p` or `properties`. The format expected format is\n`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...`\n\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending \n`:asc` (for ascending) or `:desc` (for descending).\n\nExample: use `orderBy=properties.lastName:asc` to order by a single property, \n`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. \nYou may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`.\n","plainTextDescription":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by p or properties. The format expected format is\norderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending\n:asc (for ascending) or :desc (for descending).\nExample: use orderBy=properties.lastName:asc to order by a single property,\norderBy=properties.lastName,properties.firstName,properties.age:desc to order by multiple properties.\nYou may also use the shorthand p instead of properties such as orderBy=p.lastName:asc.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.\n","plainTextDescription":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.","example":["master"]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \nAll markings from a conjunctive set must be met for access.\n\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\n\nAll markings from a conjunctive set must be met for access.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of a query.","plainTextDescription":"Details about a parameter of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fullLogicRules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns the full metadata for an Action type in the Ontology.","plainTextDescription":"Returns the full metadata for an Action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction.","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"},"type":{"type":"object","object":{"properties":{"useGrouping":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","plainTextDescription":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","example":[]}},"convertNegativeToParenthesis":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, wrap negative numbers in parentheses instead of a minus sign.","plainTextDescription":"If true, wrap negative numbers in parentheses instead of a minus sign.","example":[]}},"minimumIntegerDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"notation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"roundingMode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\n\nExamples:\n- useGrouping: true makes 1234567 display as \"1,234,567\"\n- maximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\n- notation: SCIENTIFIC makes 1234 display as \"1.234E3\"\n","plainTextDescription":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\nExamples:\n\nuseGrouping: true makes 1234567 display as \"1,234,567\"\nmaximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\nnotation: SCIENTIFIC makes 1234 display as \"1.234E3\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","ALL_V2_WITH_DELETIONS","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"geotimeSeriesValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Resolved data values pointed to by a reference.","plainTextDescription":"Resolved data values pointed to by a reference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"}}}},"restrictedView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"}}}},"stream":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"}}}},"mediaSetView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"}}}},"direct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"}}}},"geotimeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"}}}},"editsOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"}}}},"dataset":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"}}}},"table":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.\n","plainTextDescription":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"threeDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"twoDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}}},"typeReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"}}}},"void":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VoidType"}}}},"entrySet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"null":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"NullType"}}}},"interfaceObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Query parameters or outputs.\n","plainTextDescription":"A union of all the types supported by Ontology Query parameters or outputs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.\n","plainTextDescription":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups with the specified width.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the value type in the API in camelCase format.","plainTextDescription":"The name of the value type in the API in camelCase format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"humanReadable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"}}}},"timecode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[false]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\n\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"},"type":{"type":"object","object":{"properties":{"responses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.\n","plainTextDescription":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property bound to a single column in the backing datasource.","plainTextDescription":"A property bound to a single column in the backing datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"},"type":{"type":"enum","enum":{"values":["NANOSECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS"]}},"safety":"SAFE","documentation":{"description":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","plainTextDescription":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked object type.","plainTextDescription":"A reference to the linked object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKeyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object identifier containing an object type API name and primary key.","plainTextDescription":"An object identifier containing an object type API name and primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"numNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.\n","plainTextDescription":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.","example":[]}},"similarityThreshold":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.\n","plainTextDescription":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.","example":[]}},"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet containing the top `numNeighbors` objects with `propertyIdentifier` nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\n\nA non-zero score for each resulting object is returned when the `orderType` in the `orderBy` field is set to\n`relevance`. Note that:\n - Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction \n or intersection with non-nearestNeighbors object sets.\n - If results have scores, the order of the scores will be decreasing (duplicate scores are possible).\n","plainTextDescription":"ObjectSet containing the top numNeighbors objects with propertyIdentifier nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\nA non-zero score for each resulting object is returned when the orderType in the orderBy field is set to\nrelevance. Note that:\n\nScores will not be returned if a nearestNeighbors object set is composed through union, subtraction\nor intersection with non-nearestNeighbors object sets.\nIf results have scores, the order of the scores will be decreasing (duplicate scores are possible).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Reason"},"type":{"type":"object","object":{"properties":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"},"type":{"type":"enum","enum":{"values":["ACCURATE","APPROXIMATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelStrategy"},"type":{"type":"enum","enum":{"values":["PREFER_EXISTING","PREFER_DEFAULT","EXISTING_ONLY","DEFAULT_ONLY"]}},"safety":"SAFE","documentation":{"description":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to `PREFER_EXISTING`.\n\n- `PREFER_EXISTING`: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\n- `PREFER_DEFAULT`: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\n- `EXISTING_ONLY`: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\n- `DEFAULT_ONLY`: use the default channel configured in ontology metadata only; error if none is configured.\n","plainTextDescription":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to PREFER_EXISTING.\n\nPREFER_EXISTING: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\nPREFER_DEFAULT: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\nEXISTING_ONLY: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\nDEFAULT_ONLY: use the default channel configured in ontology metadata only; error if none is configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.\n","plainTextDescription":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying any of the rules in the query\n","plainTextDescription":"Matches intervals satisfying any of the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}},"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"}}}},"groupMember":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"}}}},"objectPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"arraySize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}},"unevaluable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. |\n| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. |\n| `oneOf` | The parameter has a manually predefined set of options. |\n| `range` | The parameter value must be within the defined range. |\n| `stringLength` | The parameter value must have a length within the defined range. |\n| `stringRegexMatch` | The parameter value must match a predefined regular expression. |\n| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |\n","plainTextDescription":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| arraySize | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| groupMember | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| objectPropertyValue | The parameter value must be a property value of an object found within an object set. |\n| objectQueryResult | The parameter value must be the primary key of an object found within an object set. |\n| oneOf | The parameter has a manually predefined set of options. |\n| range | The parameter value must be within the defined range. |\n| stringLength | The parameter value must have a length within the defined range. |\n| stringRegexMatch | The parameter value must match a predefined regular expression. |\n| unevaluable | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesValueBankProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesV2Response"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherText"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A value encrypted with [Cipher](/docs/foundry/cipher/overview/), stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example `CIPHER::{cipherChannelRid}::::CIPHER`).\n","plainTextDescription":"A value encrypted with Cipher, stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example CIPHER::{cipherChannelRid}::::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"},"type":{"type":"enum","enum":{"values":["ASCENDING_NULLS_LAST","DESCENDING_NULLS_LAST"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologyValueTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"},"type":{"type":"enum","enum":{"values":["SECONDS","MILLISECONDS"]}},"safety":"SAFE","documentation":{"description":"Specifies the unit of the input duration value.","plainTextDescription":"Specifies the unit of the input duration value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"},"type":{"type":"enum","enum":{"values":["DATE_FORMAT_RELATIVE_TO_NOW","DATE_FORMAT_DATE","DATE_FORMAT_YEAR_AND_MONTH","DATE_FORMAT_DATE_TIME","DATE_FORMAT_DATE_TIME_SHORT","DATE_FORMAT_TIME","DATE_FORMAT_ISO_INSTANT"]}},"safety":"SAFE","documentation":{"description":"Localized date/time format types.","plainTextDescription":"Localized date/time format types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field starts with the provided value.","plainTextDescription":"Returns objects where the specified field starts with the provided value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}}],"errors":[{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action type is not found, or the user does not have access to it.","plainTextDescription":"The action type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MalformedPropertyFilters"},"errorType":"INVALID_ARGUMENT","parameters":{"malformedPropertyFilter":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`.\n","plainTextDescription":"At least one of requested filters are malformed. Please look at the documentation of PropertyFilter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValue"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyEditsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"editsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"editsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.\n","plainTextDescription":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotSynced"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.\n","plainTextDescription":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleMediaUploadDestinations"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.\n","plainTextDescription":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an object type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an object type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupCountExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"groupsCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"groupsLimit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiNamesNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"derivedPropertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested derived property API names already exist on the object set.","plainTextDescription":"At least one of the requested derived property API names already exist on the object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterInterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an interface type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an interface type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedInterfaceBasedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","plainTextDescription":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionNotFound"},"errorType":"NOT_FOUND","parameters":{"actionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action is not found, or the user does not have access to it.","plainTextDescription":"The action is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnknownParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"expectedParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameters were not found. Please look at the `knownParameters` field\nto see which ones are available.\n","plainTextDescription":"The provided parameters were not found. Please look at the knownParameters field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionNotSupportedWithTransaction"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The function runtime does not support execution with a transaction.\n","plainTextDescription":"The function runtime does not support execution with a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectSetRidNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object set RID is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object set RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByValue"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.\n","plainTextDescription":"Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDerivedPropertyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.\n","plainTextDescription":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentType"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The `Content-Type` cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.\n","plainTextDescription":"The Content-Type cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValueForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkPropertyMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property could not be mapped to a Marketplace installation.","plainTextDescription":"The given property could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinitionOnInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.\n","plainTextDescription":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested properties are not found on the object type.","plainTextDescription":"The requested properties are not found on the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionInvalidInput"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsReadOnlyEntity"},"errorType":"INVALID_ARGUMENT","parameters":{"entityTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action request performs edits on a type that is read-only or does not allow edits.","plainTextDescription":"The given action request performs edits on a type that is read-only or does not allow edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadPropertyNotBackedByMediaSetView"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.\n","plainTextDescription":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidVectorDimension"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"providedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","plainTextDescription":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortOrder"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortOrder":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.\n","plainTextDescription":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrdering"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.\n","plainTextDescription":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotResolvable"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.\n","plainTextDescription":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkIdsDoNotExistInActionType"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownUniqueIdentifierLinkIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.\n","plainTextDescription":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortType"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","plainTextDescription":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Failed to find a provided property for a given object.\n","plainTextDescription":"Failed to find a provided property for a given object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRidNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type RID is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFiltersCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided filters cannot be used together.","plainTextDescription":"The provided filters cannot be used together.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The object the user is attempting to create already exists.\n","plainTextDescription":"The object the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadDestinationNotConfigured"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.\n","plainTextDescription":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiNameNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"ontologyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","plainTextDescription":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFilterable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and\n*Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked *Searchable* and *Selectable* and when it can be used.\n","plainTextDescription":"Results could not be filtered by the requested properties. Please mark the properties as Searchable and\nSelectable in the Ontology Manager to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked Searchable and Selectable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.\n","plainTextDescription":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object set is not found, or the client token does not have access to it.","plainTextDescription":"The requested object set is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DuplicateOrderBy"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order includes duplicate properties.","plainTextDescription":"The requested sort order includes duplicate properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionEncounteredUserFacingError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParametersNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"unknownParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"configuredParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field\nto see which ones are available.\n","plainTextDescription":"The provided parameter ID was not found for the action. Please look at the configuredParameterIds field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The link type is not found, or the user does not have access to it.","plainTextDescription":"The link type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingInterfaceProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property types are not present on every object type.","plainTextDescription":"The requested interface property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HighScaleComputationNotEnabled"},"errorType":"TIMEOUT","parameters":{},"documentation":{"description":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","plainTextDescription":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value type is not found, or the user does not have access to it.","plainTextDescription":"The value type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidUserId"},"errorType":"INVALID_ARGUMENT","parameters":{"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a user id must be a UUID.","plainTextDescription":"The provided value for a user id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationNestedObjectSetSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"objectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"objectsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.\n","plainTextDescription":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMemoryExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"memoryUsedBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"memoryLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFiltersNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for\na list of supported property filters.\n","plainTextDescription":"At least one of the requested property filters are not supported. See the documentation of PropertyFilter for\na list of supported property filters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The link the user is attempting to create already exists.\n","plainTextDescription":"The link the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDepthExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"depth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"depthLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.\n","plainTextDescription":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidRangeQuery"},"errorType":"INVALID_ARGUMENT","parameters":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}},"field":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The specified query range filter is invalid.\n","plainTextDescription":"The specified query range filter is invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinition"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition was invalid due to shape of query or type checking.","plainTextDescription":"Derived property definition was invalid due to shape of query or type checking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.\n","plainTextDescription":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ViewObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.\n","plainTextDescription":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"metricType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.\n","plainTextDescription":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryNotFound"},"errorType":"NOT_FOUND","parameters":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query is not found, or the user does not have access to it.","plainTextDescription":"The query is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by interface property type.\n","plainTextDescription":"Range group by is not supported by interface property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DistinctEnumValuesExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"maxDistinctValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","plainTextDescription":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingValueTypeReference"},"errorType":"INVALID_ARGUMENT","parameters":{"referencedRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","plainTextDescription":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `PropertyValue` for details on\nhow properties are represented.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of PropertyValue for details on\nhow properties are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionValidationFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The validation failed for the given action parameters. Please use the `validateAction` endpoint for more\ndetails.\n","plainTextDescription":"The validation failed for the given action parameters. Please use the validateAction endpoint for more\ndetails.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSortable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and\n*Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay\nbetween the time a property is set to *Searchable* and *Sortable* and when it can be used.\n","plainTextDescription":"Results could not be ordered by the requested properties. Please mark the properties as Searchable and\nSortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay\nbetween the time a property is set to Searchable and Sortable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleGroupByOnFieldNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"duplicateFields":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation cannot group by on the same field multiple times.\n","plainTextDescription":"Aggregation cannot group by on the same field multiple times.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The linked object with the given primary key is not found, or the user does not have access to it.","plainTextDescription":"The linked object with the given primary key is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypesSearchNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The search on the property types are not supported. See the `Search Objects` documentation for\na list of supported search queries on different property types.\n","plainTextDescription":"The search on the property types are not supported. See the Search Objects documentation for\na list of supported search queries on different property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryOutputValue"},"errorType":"INVALID_ARGUMENT","parameters":{"outputDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"outputValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.\n","plainTextDescription":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFoundOnObject"},"errorType":"INVALID_ARGUMENT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectPropertyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","plainTextDescription":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterBaseType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterDataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface link type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface link type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectChanged"},"errorType":"CONFLICT","parameters":{"primaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An object used by this `Action` was changed by someone else while the `Action` was running.\n","plainTextDescription":"An object used by this Action was changed by someone else while the Action was running.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set is not supported.","plainTextDescription":"The requested object set is not supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryVersionNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query could not be found at the provided version.\n","plainTextDescription":"The query could not be found at the provided version.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested shared property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditedPropertiesNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.\n","plainTextDescription":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property was not found on the interface type.","plainTextDescription":"The requested interface property was not found on the interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncingObjectTypes"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more requested object types have been changed in the **Ontology Manager** and changes are currently being\napplied. Wait a few seconds and try again.\n","plainTextDescription":"One or more requested object types have been changed in the Ontology Manager and changes are currently being\napplied. Wait a few seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRange"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation range should include one lt or lte and one gt or gte.\n","plainTextDescription":"Aggregation range should include one lt or lte and one gt or gte.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionTimedOut"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryMemoryExceededLimit"},"errorType":"TIMEOUT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Memory limits were exceeded for the `Query` execution.\n","plainTextDescription":"Memory limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidApplyActionOptionCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidCombination":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given options are individually valid but cannot be used in the given combination.","plainTextDescription":"The given options are individually valid but cannot be used in the given combination.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTimeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Time limits were exceeded for the `Query` execution.\n","plainTextDescription":"Time limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConsistentSnapshotError"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.\n","plainTextDescription":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CompositePrimaryKeyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RateLimitReached"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.\n","plainTextDescription":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SimilarityThresholdOutOfRange"},"errorType":"INVALID_ARGUMENT","parameters":{"providedThreshold":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","plainTextDescription":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDefinitionOutOfSync"},"errorType":"CONFLICT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The ontology definition is temporarily out of sync. The indexed definition does not yet \nreflect the latest saved definition for this type. This is typically a transient condition that \nresolves as indexing completes.\n","plainTextDescription":"The ontology definition is temporarily out of sync. The indexed definition does not yet\nreflect the latest saved definition for this type. This is typically a transient condition that\nresolves as indexing completes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFilterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyFilterValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\n`isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type.\n","plainTextDescription":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\nisNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryEncounteredUserFacingError"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored Query failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsNotSupportedWithMarketplace"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Returning action edits is not supported when using marketplace bindings.\n","plainTextDescription":"Returning action edits is not supported when using marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBaseTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IncompatibleNestedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.\n","plainTextDescription":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypesNotSynced"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.\n","plainTextDescription":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnauthorizedCipherOperation"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to take a specific Cipher operation.\n","plainTextDescription":"The provided token does not have permission to take a specific Cipher operation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentLength"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A `Content-Length` header is required for all uploads, but was missing or invalid.","plainTextDescription":"A Content-Length header is required for all uploads, but was missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypesNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface types were not found, or the client token does not have access to it.","plainTextDescription":"The requested interface types were not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingSharedProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property types are not present on every object type.","plainTextDescription":"The requested shared property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrderingWithNullValues"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.\n","plainTextDescription":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"fileSizeBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fileLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.\n","plainTextDescription":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsModifiedConcurrently"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.\n","plainTextDescription":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplePropertyValuesNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.\n","plainTextDescription":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a runtime error.\n","plainTextDescription":"The authored Query failed to execute because of a runtime error.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyExactMatchingNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that does not support exact matching is used in a setting that requires exact matching.","plainTextDescription":"A property that does not support exact matching is used in a setting that requires exact matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeDoesNotSupportNearestNeighbors"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","plainTextDescription":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to edit this `ObjectType`.\n","plainTextDescription":"The user does not have permission to edit this ObjectType.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSearchable"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Search is not enabled on the specified properties. Please mark the properties as *Searchable*\nin the **Ontology Manager** to enable search on them. There may be a short delay\nbetween the time a property is marked *Searchable* and when it can be used.\n","plainTextDescription":"Search is not enabled on the specified properties. Please mark the properties as Searchable\nin the Ontology Manager to enable search on them. There may be a short delay\nbetween the time a property is marked Searchable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotCipherFormatted"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHER::::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHERCIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentNotFound"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested attachment is not found, or the client token does not have access to it. \nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.\n","plainTextDescription":"The requested attachment is not found, or the client token does not have access to it.\nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionContainsDuplicateEdits"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The given action request has multiple edits on the same object.","plainTextDescription":"The given action request has multiple edits on the same object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not found, or the client token does not have access to it.","plainTextDescription":"The requested object type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidTransactionEditPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `DataValue` for details on\nhow properties are represented for transaction edits.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of DataValue for details on\nhow properties are represented for transaction edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object is not found, or the client token does not have access to it.","plainTextDescription":"The requested object is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotFound"},"errorType":"NOT_FOUND","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.\n","plainTextDescription":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidOrderType"},"errorType":"INVALID_ARGUMENT","parameters":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This query type does not support the provided order type","plainTextDescription":"This query type does not support the provided order type","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParentAttachmentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to parent attachments.\n","plainTextDescription":"The user does not have permission to parent attachments.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the **Ontology Manager**.\n","plainTextDescription":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TooManyNearestNeighborsRequested"},"errorType":"INVALID_ARGUMENT","parameters":{"requestedNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"maxNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","plainTextDescription":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceBasedObjectSetNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set type is not supported for interface-based object sets.","plainTextDescription":"The requested object set type is not supported for interface-based object sets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid interface property type for duration groupBy.\n","plainTextDescription":"Invalid interface property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BranchNotSupportedWithMarketplaceQuery"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The branch parameter is not supported when executing queries with marketplace bindings.\n","plainTextDescription":"The branch parameter is not supported when executing queries with marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DefaultAndNullGroupsNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Exact match groupBy clause cannot specify a default value and allow null values.\n","plainTextDescription":"Exact match groupBy clause cannot specify a default value and allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UndecryptableValue"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER:::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditMissingPrimaryKey"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.\n","plainTextDescription":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidGroupId"},"errorType":"INVALID_ARGUMENT","parameters":{"groupId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a group id must be a UUID.","plainTextDescription":"The provided value for a group id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by property type.\n","plainTextDescription":"Range group by is not supported by property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidFields"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given field does not match the expected pattern. For example, an Ontology object property `id`\nshould be written `properties.id`.\n","plainTextDescription":"The value of the given field does not match the expected pattern. For example, an Ontology object property id\nshould be written properties.id.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyNotFound"},"errorType":"NOT_FOUND","parameters":{"ontologyRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested Ontology is not found, or the client token does not have access to it.","plainTextDescription":"The requested Ontology is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"localObjectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncing"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a\nfew seconds and try again.\n","plainTextDescription":"The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a\nfew seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property type is not of the expected type.\n","plainTextDescription":"The given property type is not of the expected type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid property type for duration groupBy.\n","plainTextDescription":"Invalid property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Required parameters are missing. Please look at the `parameters` field to see which required parameters are\nmissing from the request.\n","plainTextDescription":"Required parameters are missing. Please look at the parameters field to see which required parameters are\nmissing from the request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRidAlreadyExists"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided attachment RID already exists and cannot be overwritten.\n","plainTextDescription":"The provided attachment RID already exists and cannot be overwritten.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksNotSupported"},"errorType":"FAILED_PRECONDITION","parameters":{},"documentation":{"description":"Bulk loading object set links is not supported by Object Storage v1.\n","plainTextDescription":"Bulk loading object set links is not supported by Object Storage v1.","example":[]}}]}; +export const OntologiesV2: Namespace = {"name":"Ontologies","version":"v2","outputAuditVersions":"V3_ONLY","resources":[{"singleton":false,"documentation":{"description":"Ontologies are categorizations of data into real-world concepts. Those concepts are represented by object types, properties, link types, and action types. Together, these concepts form a descriptive object graph that links together all the key entities in an organization.\n\nFor more information, please refer to the [Ontology](/docs/foundry/ontology/overview/) user documentation.\n\n:::callout{theme=neutral title=Note}\nOntology changes are eventually consistent, and it may take few minutes for the API to reflect new Ontologies. \nAfter adding a new Ontology, the API may return an `OntologyNotFound` error for a few minutes.\n:::\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyV2"},"pluralName":"OntologiesV2","operations":[{"name":"listOntologiesV2","verb":"list","documentation":{"description":"Lists the Ontologies visible to the current user.\n","plainTextDescription":"Lists the Ontologies visible to the current user.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies","httpMethod":"GET","parameters":[],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"},{"apiName":"shared-ontology","displayName":"Shared ontology","description":"The ontology shared with our suppliers","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesV2Response"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOntologyV2","verb":"get","documentation":{"description":"Gets a specific ontology for a given Ontology API name or RID.\n","plainTextDescription":"Gets a specific ontology for a given Ontology API name or RID.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"default-ontology","displayName":"Ontology","description":"The default ontology","rid":"ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOntologyFullMetadata","verb":"getFullMetadata","documentation":{"description":"Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces.\nThis endpoint is designed to return as much metadata as possible in a single request to support OSDK workflows.\nIt may omit certain entities rather than fail the request.\n","plainTextDescription":"Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces.\nThis endpoint is designed to return as much metadata as possible in a single request to support OSDK workflows.\nIt may omit certain entities rather than fail the request.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/fullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"loadOntologyMetadata","verb":"loadMetadata","documentation":{"description":"Load Ontology metadata for the requested object, link, action, query, and interface types.\n","plainTextDescription":"Load Ontology metadata for the requested object, link, action, query, and interface types.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/metadata","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load metadata from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadOntologyMetadataRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An action type represents a set of changes and logic that can be applied in the Ontology. Action types are \ncreated in the **Ontology Manager**. For more information, refer to the\n[action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ActionTypeV2"},"pluralName":"ActionTypesV2","operations":[{"name":"listActionTypesV2","verb":"list","documentation":{"description":"Lists the action types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the action types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},{"apiName":"move-office","description":"Update an office's physical location","parameters":{"officeId":{"dataType":{"type":"string"}},"newAddress":{"description":"The office's new physical address (not necessarily shipping address)","dataType":{"type":"string"}},"newCapacity":{"description":"The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher)","dataType":{"type":"integer"}}},"rid":"ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchActionTypesV2","verb":"search","documentation":{"description":"Search for action types in the given Ontology that match the provided filters. Results are returned by\nrelevance of the match unless an explicit `orderBy` is provided.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. Search results are eventually\nconsistent with the latest Ontology version and may lag slightly behind the last Ontology modification.\n","plainTextDescription":"Search for action types in the given Ontology that match the provided filters. Results are returned by\nrelevance of the match unless an explicit orderBy is provided.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. Search results are eventually\nconsistent with the latest Ontology version and may lag slightly behind the last Ontology modification.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/search","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to search the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to search the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"where":{"type":"actionTypeDisplayName","value":{"type":"contains","value":"promote"}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"totalCount":"1","data":[{"apiName":"promote-employee","description":"Update an employee's title and compensation","rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeV2","verb":"get","documentation":{"description":"Gets a specific action type with the given API name.\n","plainTextDescription":"Gets a specific action type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/{actionType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The name of the action type in the API.\n","plainTextDescription":"The name of the action type in the API.","example":["promote-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeByRid","verb":"getByRid","documentation":{"description":"Gets a specific action type with the given RID.\n","plainTextDescription":"Gets a specific action type with the given RID.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionTypeRid","documentation":{"description":"The RID of the action type.\n","plainTextDescription":"The RID of the action type.","example":["ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeByRidBatch","verb":"getByRidBatch","documentation":{"description":"Gets a list of action types by RID in bulk.\n\nAction types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of action types by RID in bulk.\nAction types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequest"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An action type represents a set of changes and logic that can be applied in the Ontology. Action types are \ncreated in the **Ontology Manager**. For more information, refer to the\n[action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"},"pluralName":"ActionTypesFullMetadata","operations":[{"name":"listActionTypesFullMetadata","verb":"list","documentation":{"description":"Lists the action types (with full metadata) for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the action types (with full metadata) for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypesFullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the action types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectTypeApiNames","documentation":{"description":"A set of object type API names that can be used to filter which actions are returned.\n","plainTextDescription":"A set of object type API names that can be used to filter which actions are returned.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"actionType":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},"fullLogicRule":[{"createObject":{"objectTypeApiName":"promote-employee","propertyArguments":{"employeeId":{"objectParameterPropertyValue":{"parameterId":"employeeId","propertyTypeApiName":"employeeId"}},"title":{"parameterId":{"parameterId":"newTitle"}},"compensation":{"parameterId":{"parameterId":"newCompensation"}}}}}]}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesFullMetadataResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeFullMetadata","verb":"get","documentation":{"description":"Gets the full metadata associated with an action type.\n","plainTextDescription":"Gets the full metadata associated with an action type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/{actionType}/fullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"description":"The API name of the ontology. To find the API name, use the **List ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the ontology. To find the API name, use the List ontologies endpoint or\ncheck the Ontology Manager.","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"actionType","documentation":{"description":"The name of the action type in the API.\n","plainTextDescription":"The name of the action type in the API.","example":["promote-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"actionType":{"apiName":"promote-employee","description":"Update an employee's title and compensation","parameters":{"employeeId":{"dataType":{"type":"integer"}},"newTitle":{"dataType":{"type":"string"}},"newCompensation":{"dataType":{"type":"double"}}},"rid":"ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167"},"fullLogicRule":[{"createObject":{"objectTypeApiName":"promote-employee","propertyArguments":{"employeeId":{"objectParameterPropertyValue":{"parameterId":"employeeId","propertyTypeApiName":"employeeId"}},"title":{"parameterId":{"parameterId":"newTitle"}},"compensation":{"parameterId":{"parameterId":"newCompensation"}}}}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getActionTypeFullMetadataBatch","verb":"getFullMetadataBatch","documentation":{"description":"Gets a list of action types with full metadata (parameters and logic rules) by their API names in\nbulk.\n\nAction types are filtered from the response if they don't exist, the requesting token lacks the\nrequired permissions, or any of their logic rules are not supported by this API, so the response may\ncontain fewer entries than requested.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of action types with full metadata (parameters and logic rules) by their API names in\nbulk.\nAction types are filtered from the response if they don't exist, the requesting token lacks the\nrequired permissions, or any of their logic rules are not supported by this API, so the response may\ncontain fewer entries than requested.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actionTypes/getFullMetadataBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"This represents an object type within a Foundry Ontology. For more information, review the \n[Object Type](/docs/foundry/object-link-types/object-types-overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"},"pluralName":"ObjectTypesV2","operations":[{"name":"listObjectTypesV2","verb":"list","documentation":{"description":"Lists the object types for the given Ontology.\n\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.\n\nNote: the `aliases` field is not populated on this endpoint and will always be empty. To retrieve object type\naliases, use the get-by-RID read paths (e.g. `getObjectTypeV2`).\n","plainTextDescription":"Lists the object types for the given Ontology.\nEach page may be smaller or larger than the requested page size. However, it is guaranteed that if there are\nmore results available, at least one result will be present in the\nresponse.\nNote: the aliases field is not populated on this endpoint and will always be empty. To retrieve object type\naliases, use the get-by-RID read paths (e.g. getObjectTypeV2).","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the object types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the object types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"includeDatasources","documentation":{"description":"When set to `true`, the `datasources` field on each returned object type is populated with the\ndatasources backing it. Defaults to `false`.\n","plainTextDescription":"When set to true, the datasources field on each returned object type is populated with the\ndatasources backing it. Defaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","displayName":"Employee","status":"ACTIVE","primaryKey":"employeeId","properties":{"employeeId":{"dataType":{"type":"integer"},"rid":"ri.ontology.main.property.571d3d4d-150a-4dd4-b1a7-d16c1ed7d996"},"fullName":{"dataType":{"type":"string"},"rid":"ri.ontology.main.property.5721baa7-26d5-4ca8-b092-d47dcc724ab1"},"office":{"description":"The unique ID of the employee's primary assigned office","dataType":{"type":"string"},"rid":"ri.ontology.main.property.554fa8c4-3b6e-4d3f-adef-acc9f0f54633"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","dataType":{"type":"date"},"rid":"ri.ontology.main.property.3b081417-fe68-4010-ade8-68b298116ed4"},"rid":"ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44"}},{"apiName":"office","description":"A physical location (not including rented co-working spaces)","displayName":"Office","status":"ACTIVE","primaryKey":"officeId","properties":{"officeId":{"dataType":{"type":"string"}},"address":{"description":"The office's physical address (not necessarily shipping address)","dataType":{"type":"string"}},"capacity":{"description":"The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher)","dataType":{"type":"integer"}},"rid":"ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesV2Response"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeV2","verb":"get","documentation":{"description":"Gets a specific object type with the given API name.\n","plainTextDescription":"Gets a specific object type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"includeDatasources","documentation":{"description":"When set to `true`, the `datasources` field on the returned object type is populated with the\ndatasources backing it. Defaults to `false`.\n","plainTextDescription":"When set to true, the datasources field on the returned object type is populated with the\ndatasources backing it. Defaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"employee","description":"A full-time or part-time employee of our firm","displayName":"Employee","status":"ACTIVE","primaryKey":"employeeId","properties":{"employeeId":{"dataType":{"type":"integer"},"rid":"ri.ontology.main.property.571d3d4d-150a-4dd4-b1a7-d16c1ed7d996"},"fullName":{"dataType":{"type":"string"},"rid":"ri.ontology.main.property.5721baa7-26d5-4ca8-b092-d47dcc724ab1"},"office":{"description":"The unique ID of the employee's primary assigned office","dataType":{"type":"string"},"rid":"ri.ontology.main.property.554fa8c4-3b6e-4d3f-adef-acc9f0f54633"},"startDate":{"description":"The date the employee was hired (most recently, if they were re-hired)","dataType":{"type":"date"},"rid":"ri.ontology.main.property.3b081417-fe68-4010-ade8-68b298116ed4"}},"rid":"ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeByRidBatch","verb":"getByRidBatch","documentation":{"description":"Gets a list of object types by RID in bulk.\n\nObject types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of object types by RID in bulk.\nObject types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequest"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeFullMetadata","verb":"getFullMetadata","documentation":{"description":"Gets the full metadata for a specific object type with the given API name.\n","plainTextDescription":"Gets the full metadata for a specific object type with the given API name.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"includeDatasources","documentation":{"description":"When set to `true`, the `datasources` field on the returned object type is populated with the\ndatasources backing it. Defaults to `false`.\n","plainTextDescription":"When set to true, the datasources field on the returned object type is populated with the\ndatasources backing it. Defaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeFullMetadataBatch","verb":"getFullMetadataBatch","documentation":{"description":"Gets the full metadata for a batch of object types, identified by their API names.\n\nSet `includeLinkTypes` to return every outgoing link type for each object type alongside its metadata,\nwithout needing to know the link type API names. Link types are ordered by their API name.\n\nObject types are returned in the order they were requested. Any that don't exist or that the requesting\ntoken lacks permissions for are silently omitted.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets the full metadata for a batch of object types, identified by their API names.\nSet includeLinkTypes to return every outgoing link type for each object type alongside its metadata,\nwithout needing to know the link type API names. Link types are ordered by their API name.\nObject types are returned in the order they were requested. Any that don't exist or that the requesting\ntoken lacks permissions for are silently omitted.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/getFullMetadataBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectTypeEditsHistory","verb":"getEditsHistory","documentation":{"description":"Returns the history of edits (additions, modifications, deletions) for objects of a\nspecific object type. This endpoint provides visibility into all actions that have\nmodified objects of this type.\n\nThe edits are returned in reverse chronological order (most recent first) by default. \n\nNote that filters are ignored for OSv1 object types.\n","plainTextDescription":"Returns the history of edits (additions, modifications, deletions) for objects of a\nspecific object type. This endpoint provides visibility into all actions that have\nmodified objects of this type.\nThe edits are returned in reverse chronological order (most recent first) by default.\nNote that filters are ignored for OSv1 object types.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"description":"The ontology RID or API name","plainTextDescription":"The ontology RID or API name","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type","plainTextDescription":"The API name of the object type","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch from which we will get edits history. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch from which we will get edits history. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to get edits history from.\n","plainTextDescription":"The resource identifier of an ontology scenario to get edits history from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response","plainTextDescription":"Success response","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOutgoingLinkTypesV2","verb":"listOutgoingLinkTypes","documentation":{"description":"List the outgoing links for an object type.\n","plainTextDescription":"List the outgoing links for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Flight"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the outgoing link types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the outgoing link types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned.","plainTextDescription":"The desired size of the page to be returned.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"originAirport","objectTypeApiName":"Airport","cardinality":"ONE","foreignKeyPropertyApiName":"originAirportId"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingLinkTypeV2","verb":"getOutgoingLinkType","documentation":{"description":"Get an outgoing link for an object type.\n","plainTextDescription":"Get an outgoing link for an object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the outgoing link.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the outgoing link.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"directReport","objectTypeApiName":"Employee","cardinality":"MANY"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingLinkTypesByObjectTypeRidBatch","verb":"getOutgoingLinkTypesByObjectTypeRidBatch","documentation":{"description":"Gets outgoing link types for a batch of object types, identified by their RIDs.\n\nFor each requested object type, returns the list of outgoing link types visible to the\nrequesting token. Optionally, results can be filtered to only include specific link type RIDs.\n\nObject types that don't exist or that the requesting token lacks permissions for are\nsilently omitted from the response.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets outgoing link types for a batch of object types, identified by their RIDs.\nFor each requested object type, returns the list of outgoing link types visible to the\nrequesting token. Optionally, results can be filtered to only include specific link type RIDs.\nObject types that don't exist or that the requesting token lacks permissions for are\nsilently omitted from the response.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequest"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Object is a data container for a specific instance of an [Object Type](/docs/foundry/object-link-types/object-types-overview/). For instance, the Employee object type may contain data about several employees, and each one is represented as a single Object.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"},"pluralName":"OntologyObjectsV2","operations":[{"name":"listObjectsV2","verb":"list","documentation":{"description":"Lists the objects for the given Ontology and object type.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the objects for the given Ontology and object type.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":50030,"__apiName":"Employee","id":50030,"firstName":"John","lastName":"Doe"},{"__rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","__primaryKey":20090,"__apiName":"Employee","id":20090,"firstName":"John","lastName":"Haymore"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectV2","verb":"get","documentation":{"description":"Gets a specific object with the given primary key.\n","plainTextDescription":"Gets a specific object with the given primary key.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the requested object. To look up the expected primary key for your object type, use the\n`Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested object. To look up the expected primary key for your object type, use the\nGet object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the object from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the object from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":50030,"__apiName":"Employee","id":50030,"firstName":"John","lastName":"Doe"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"countObjects","verb":"count","documentation":{"description":"Returns a count of the objects of the given object type.\n","plainTextDescription":"Returns a count of the objects of the given object type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/count","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to count the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to count the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"count":100}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchObjectsV2","verb":"search","documentation":{"description":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| 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 term 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| startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string |\n\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\n\nThe `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a `nextPageToken`, the remaining\nobjects can be retrieved by requesting subsequent pages.\n","plainTextDescription":"Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\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| 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 term 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| startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string |\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'\"~). Periods (.) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\nThe pageSize parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a nextPageToken, the remaining\nobjects can be retrieved by requesting subsequent pages.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/search","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"where":{"type":"eq","field":"age","value":21}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"__rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb","__primaryKey":1000,"__apiName":"Employee","employeeId":1000,"lastName":"smith","firstName":"john","age":21}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"aggregateObjectsV2","verb":"aggregate","documentation":{"description":"Perform functions on object fields in the specified ontology and object type.\n","plainTextDescription":"Perform functions on object fields in the specified ontology and object type.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/aggregate","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The type of the object to aggregate on.","plainTextDescription":"The type of the object to aggregate on.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"aggregation":[{"type":"min","field":"tenure","name":"min_tenure"},{"type":"avg","field":"tenure","name":"avg_tenure"}],"where":{"type":"eq","field":"name","value":"john"},"groupBy":[{"field":"startDate","type":"range","ranges":[{"startValue":"2020-01-01","endValue":"2020-06-01"}]},{"field":"city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Linked Object describes a object that is linked to another object.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"LinkedObjectV2"},"pluralName":"LinkedObjectsV2","operations":[{"name":"listLinkedObjectsV2","verb":"listLinkedObjects","documentation":{"description":"Lists the linked objects for a specific object and the given link type.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the linked objects for a specific object and the given link type.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list linked objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list linked objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"__rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","__primaryKey":80060,"__apiName":"Employee","id":80060,"firstName":"Anna","lastName":"Smith"},{"__rid":"ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136","__primaryKey":51060,"__apiName":"Employee","id":51060,"firstName":"James","lastName":"Matthews"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getLinkedObjectV2","verb":"getLinkedObject","documentation":{"description":"Get a specific linked object that originates from another object.\n\nIf there is no link between the two objects, `LinkedObjectNotFound` is thrown.\n","plainTextDescription":"Get a specific linked object that originates from another object.\nIf there is no link between the two objects, LinkedObjectNotFound is thrown.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which the links originate. To look up the expected primary key for your\nobject type, use the Get object type endpoint or the Ontology Manager.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the **Ontology Manager**.\n","plainTextDescription":"The API name of the link that exists between the object and the requested objects.\nTo find the API name for your link type, check the Ontology Manager.","example":["directReport"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkedObjectPrimaryKey","documentation":{"description":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the requested linked object. To look up the expected primary key for your object type,\nuse the Get object type endpoint (passing the linked object type) or the Ontology Manager.","example":[80060]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":50030,"__apiName":"Employee","id":50030,"firstName":"John","lastName":"Doe"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Attachment Property is a property that references a file attachment.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"AttachmentPropertyV2"},"pluralName":"AttachmentPropertiesV2","operations":[{"name":"listPropertyAttachments","verb":"getAttachment","documentation":{"description":"Get the metadata of attachments parented to the given object.\n","plainTextDescription":"Get the metadata of attachments parented to the given object.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"type":"single","rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentMetadataResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentPropertyByRidV2","verb":"getAttachmentByRid","documentation":{"description":"Get the metadata of a particular attachment in an attachment list.\n","plainTextDescription":"Get the metadata of a particular attachment in an attachment list.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentPropertyContentV2","verb":"readAttachment","documentation":{"description":"Get the content of an attachment.\n","plainTextDescription":"Get the content of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentPropertyContentByRidV2","verb":"readAttachmentByRid","documentation":{"description":"Get the content of an attachment by its RID.\n\nThe RID must exist in the attachment array of the property.\n","plainTextDescription":"Get the content of an attachment by its RID.\nThe RID must exist in the attachment array of the property.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object containing the attachment.\n","plainTextDescription":"The primary key of the object containing the attachment.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the attachment property. To find the API name for your attachment,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the attachment property. To find the API name for your attachment,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A MediaReference Property is a property that references a media item.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"MediaReferenceProperty"},"pluralName":"MediaReferenceProperties","operations":[{"name":"readMediaContent","verb":"getMediaContent","documentation":{"description":"Gets the content of a media item referenced by this property.\n","plainTextDescription":"Gets the content of a media item referenced by this property.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the media reference property.\n","plainTextDescription":"The primary key of the object with the media reference property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the media reference property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the media reference property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["profile_picture"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"The content stream.","plainTextDescription":"The content stream.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getMediaMetadata","verb":"getMediaMetadata","documentation":{"description":"Gets metadata about the media item referenced by this property.\n","plainTextDescription":"Gets metadata about the media item referenced by this property.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/metadata","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the media reference property.\n","plainTextDescription":"The primary key of the object with the media reference property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the media reference backed property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the media reference backed property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"","plainTextDescription":"","example":[{"sizeBytes":123,"path":"example.png","mediaType":"image/png"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MediaMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"uploadMediaContent","verb":"upload","documentation":{"description":":::callout{theme=warning title=Warning}\nThis endpoint is deprecated. Use the **Upload media** endpoint to upload a media item and receive a\ntemporary media reference instead.\n:::\nUploads a media item to the media set which backs the specified property. The property must be backed by a single media set and branch, otherwise an error will be thrown.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n","plainTextDescription":"This endpoint is deprecated. Use the Upload media endpoint to upload a media item and receive a\ntemporary media reference instead.\n\nUploads a media item to the media set which backs the specified property. The property must be backed by a single media set and branch, otherwise an error will be thrown.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/media/{property}/upload","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the media reference property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the media reference property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["profile_picture"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"mediaItemPath","documentation":{"description":"A path for the media item within its backing media set. Required if the backing media set requires paths.\n","plainTextDescription":"A path for the media item within its backing media set. Required if the backing media set requires paths.","example":["my-file.png"]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"The media reference for the uploaded media.","plainTextDescription":"The media reference for the uploaded media.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReference"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Time Series property is a property that contains a time series of data points.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"TimeSeriesPropertyV2"},"pluralName":"TimeSeriesPropertiesV2","operations":[{"name":"getFirstPoint","verb":"getFirstPoint","documentation":{"description":"Get the first point of a time series property.\n","plainTextDescription":"Get the first point of a time series property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series property. To find the API name for your time series property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series property. To find the API name for your time series property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":false}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getLastPoint","verb":"getLastPoint","documentation":{"description":"Get the last point of a time series property.\n","plainTextDescription":"Get the last point of a time series property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series property. To find the API name for your time series property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series property. To find the API name for your time series property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":false}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"streamPoints","verb":"streamPoints","documentation":{"description":"Stream all of the points of a time series property.\n","plainTextDescription":"Stream all of the points of a time series property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series property. To find the API name for your time series property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series property. To find the API name for your time series property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"format","documentation":{"description":"The output format to serialize the output binary stream in. Default is\nJSON. ARROW is more efficient than JSON at streaming a large sized response.\n","plainTextDescription":"The output format to serialize the output binary stream in. Default is\nJSON. ARROW is more efficient than JSON at streaming a large sized response.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamingOutputFormat"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"range":{"type":"relative","startTime":{"when":"BEFORE","value":5,"unit":"MONTHS"},"endTime":{"when":"BEFORE","value":1,"unit":"MONTHS"}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":["eyJkYXRhIjpbeyJ0aW1lIjoiMjAyMC0wMy0wNlQxMjowMDowMFoiLCJ2YWx1ZSI6NDguNX0seyJ0aW1lIjoiMjAyMC0wMy0wNlQxMzowMDowMFoiLCJ2YWx1ZSI6NzUuMDF9LHsidGltZSI6IjIwMjAtMDMtMDZUMTQ6MDA6MDBaIiwidmFsdWUiOjMxLjMzfV19"]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Time Series Value Bank property is a property that contains a series of time based data points.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"TimeSeriesValueBankProperty"},"pluralName":"TimeSeriesValueBankProperties","operations":[{"name":"getLatestValue","verb":"getLatestValue","documentation":{"description":"Get the latest value of a property backed by a timeseries. If a specific geotime series integration has both a history and a live integration, we will give precedence to the live integration.\n","plainTextDescription":"Get the latest value of a property backed by a timeseries. If a specific geotime series integration has both a history and a live integration, we will give precedence to the live integration.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{propertyName}/latestValue","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the timeseries property.\n","plainTextDescription":"The primary key of the object with the timeseries property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"propertyName","documentation":{"description":"The API name of the timeseries property. To find the API name for your property value bank property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the timeseries property. To find the API name for your property value bank property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":false}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"streamValues","verb":"streamValues","documentation":{"description":"Stream all of the points of a time series property (this includes geotime series references).\n","plainTextDescription":"Stream all of the points of a time series property (this includes geotime series references).","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamValues","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the time series property.\n","plainTextDescription":"The primary key of the object with the time series property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the time series backed property. To find the API name,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the time series backed property. To find the API name,\ncheck the Ontology Manager or use the Get object type endpoint.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"range":{"type":"relative","startTime":{"when":"BEFORE","value":5,"unit":"MONTHS"},"endTime":{"when":"BEFORE","value":1,"unit":"MONTHS"}}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":["eyJkYXRhIjpbeyJ0aW1lIjoiMjAyMC0wMy0wNlQxMjowMDowMFoiLCJ2YWx1ZSI6NDguNX0seyJ0aW1lIjoiMjAyMC0wMy0wNlQxMzowMDowMFoiLCJ2YWx1ZSI6NzUuMDF9LHsidGltZSI6IjIwMjAtMDMtMDZUMTQ6MDA6MDBaIiwidmFsdWUiOjMxLjMzfV19"]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A Geotemporal Series property is a property that contains a series of time-based geographic positions.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesProperty"},"pluralName":"GeotemporalSeriesProperties","operations":[{"name":"loadGeotemporalSeriesEntries","verb":"loadGeotemporalSeriesEntries","documentation":{"description":"Load the geotemporal series entries for a given object's geotemporal series reference property within the\nspecified time range.\n\nEach entry in the response is a map of property names to values, following the same structure as\n`OntologyObjectV2`. Use the `additionalProperties` field in the request to control which properties are included\nin each entry depending on the underlying geotemporal integration.\n\nResults are paginated. Use the `nextPageToken` from the response to retrieve subsequent pages.\n\n:::callout{theme=warning title=Warning}\n Geotemporal series integrations with only \"cold storage\" enabled are not supported.\n:::\n","plainTextDescription":"Load the geotemporal series entries for a given object's geotemporal series reference property within the\nspecified time range.\nEach entry in the response is a map of property names to values, following the same structure as\nOntologyObjectV2. Use the additionalProperties field in the request to control which properties are included\nin each entry depending on the underlying geotemporal integration.\nResults are paginated. Use the nextPageToken from the response to retrieve subsequent pages.\n\nGeotemporal series integrations with only \"cold storage\" enabled are not supported.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/geotemporalSeries/{property}/loadEntries","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or check the\n**Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or check the\nOntology Manager.","example":["airplane"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the geotemporal series property.\n","plainTextDescription":"The primary key of the object with the geotemporal series property.","example":["XYZ123"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the geotemporal series property. To find the API name for your property, check the\n**Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the geotemporal series property. To find the API name for your property, check the\nOntology Manager or use the Get object type endpoint.","example":["locationHistory"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package RID of the generated SDK.\n","plainTextDescription":"The package RID of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"range":{"startTime":"2020-01-01T00:00:00Z","endTime":"2020-06-01T00:00:00Z"},"additionalProperties":["speed","heading"],"pageSize":100}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"time":"2020-03-06T12:00:00Z","position":{"type":"Point","coordinates":[-122.4194,37.7749]},"speed":120.5,"heading":275.3},{"time":"2020-03-06T13:00:00Z","position":{"type":"Point","coordinates":[-122.4095,37.7845]},"speed":95,"heading":180}],"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZQ"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A CipherText property is a property that contains data encrypted with [Cipher](/docs/foundry/cipher/overview/).\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"CipherTextProperty"},"pluralName":"CipherTextProperties","operations":[{"name":"decrypt","verb":"decrypt","documentation":{"description":"Decrypt the value of a ciphertext property.\n","plainTextDescription":"Decrypt the value of a ciphertext property.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the CipherText property.\n","plainTextDescription":"The primary key of the object with the CipherText property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DecryptionResult"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"encryptWithDefaultChannel","verb":"encryptWithDefaultChannel","documentation":{"description":"Encrypt a plaintext value into a CipherText value for the given object type property.\n\nThe Cipher Channel used is the default channel configured for the property in ontology metadata. This\nendpoint requires the CipherText property to have a configured `defaultCipherChannelRid`; if none is\nconfigured an error will be thrown. To encrypt against the channel of an existing object's value, use the\n**Encrypt** endpoint that accepts a `primaryKey` instead.\n","plainTextDescription":"Encrypt a plaintext value into a CipherText value for the given object type property.\nThe Cipher Channel used is the default channel configured for the property in ontology metadata. This\nendpoint requires the CipherText property to have a configured defaultCipherChannelRid; if none is\nconfigured an error will be thrown. To encrypt against the channel of an existing object's value, use the\nEncrypt endpoint that accepts a primaryKey instead.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectTypes/{objectType}/ciphertexts/{property}/encrypt","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"plaintext":"Jane Doe"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"encrypt","verb":"encrypt","documentation":{"description":"Encrypt a plaintext value into a CipherText value for the given object's CipherText property.\n\nThe Cipher Channel used is resolved based on the supplied `cipherChannelStrategy`, using the channel of the\nobject's existing ciphertext value and/or the default channel configured for the property in ontology metadata.\n","plainTextDescription":"Encrypt a plaintext value into a CipherText value for the given object's CipherText property.\nThe Cipher Channel used is resolved based on the supplied cipherChannelStrategy, using the channel of the\nobject's existing ciphertext value and/or the default channel configured for the property in ontology metadata.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/encrypt","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object with the CipherText property.\n","plainTextDescription":"The primary key of the object with the CipherText property.","example":[50030]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"property","documentation":{"description":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the **Ontology Manager** or use the **Get object type** endpoint.\n","plainTextDescription":"The API name of the CipherText property. To find the API name for your CipherText property,\ncheck the Ontology Manager or use the Get object type endpoint.","example":["performance"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"cipherChannelStrategy","documentation":{"description":"The strategy controlling which Cipher Channel is used to encrypt the value. If not specified, defaults\nto `PREFER_EXISTING`.\n","plainTextDescription":"The strategy controlling which Cipher Channel is used to encrypt the value. If not specified, defaults\nto PREFER_EXISTING.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelStrategy"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to read from. If not specified, the default branch will be used.\n","plainTextDescription":"The Foundry branch to read from. If not specified, the default branch will be used.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"plaintext":"Jane Doe"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Interface describes the contract that a set of Object Types will implement.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyInterface"},"pluralName":"OntologyInterfaces","operations":[{"name":"listInterfaceTypes","verb":"list","documentation":{"description":"Lists the interface types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the interface types for the given Ontology.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list the interface types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list the interface types from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 500.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 500.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"Athlete","displayName":"Athlete","description":"Good at sportsball","properties":{"name":{"rid":"com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b","apiName":"name","displayName":"Name","dataType":"string"}},"extendsInterfaces":["Human"],"rid":"ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getInterfaceType","verb":"get","documentation":{"description":"Gets a specific interface type with the given API name.\n","plainTextDescription":"Gets a specific interface type with the given API name.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the interface type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the interface type definition from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"Athlete","displayName":"Athlete","description":"Good at sportsball","properties":{"name":{"rid":"com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b","apiName":"name","displayName":"Name","dataType":"string"}},"extendsInterfaces":["Human"],"rid":"ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listObjectsForInterface","verb":"listObjectsForInterface","documentation":{"description":"Lists the objects for the given Ontology and interface type.\n\nNote that this endpoint does not guarantee consistency, unless you use the snapshot flag specified below. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the objects for the given Ontology and interface type.\nNote that this endpoint does not guarantee consistency, unless you use the snapshot flag specified below. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"description":"The API name of the ontology. To find the API name, use the **List ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the ontology. To find the API name, use the List ontologies endpoint or\ncheck the Ontology Manager.","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the interface type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the interface type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":50030,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":50030,"firstName":"John","lastName":"Doe"},{"$rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","$primaryKey":20090,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":20090,"firstName":"John","lastName":"Haymore"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsForInterfaceResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"searchObjectsForInterface","verb":"search","documentation":{"description":":::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:::\nSearch 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 \nqueries 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\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'\"~`). Periods (`.`) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\n\nAttempting to use an unsupported query will result in a validation error. Third-party applications using this \nendpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n\nThe `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a `nextPageToken`, the remaining\nobjects can be retrieved by requesting subsequent pages.\n","plainTextDescription":"This endpoint will be removed once TS OSDK is updated to use objectSets/loadObjects with interface object\nsets.\n\nSearch 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\nqueries are supported:\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 |\nQueries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (?!,:;-[](){}'\"~). Periods (.) on their own are ignored.\nPartial terms are not matched by terms filters except where explicitly noted.\nAttempting to use an unsupported query will result in a validation error. Third-party applications using this\nendpoint via OAuth2 must request the following operation scope: api:ontologies-read.\nThe pageSize parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a nextPageToken, the remaining\nobjects can be retrieved by requesting subsequent pages.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}/search","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to search objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsForInterfaceRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"__rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb","__primaryKey":1000,"__apiName":"Employee","employeeId":1000,"lastName":"smith","firstName":"john","age":21}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"aggregateObjectsForInterface","verb":"aggregate","documentation":{"description":":::callout{theme=warning title=Warning}\nThis endpoint will be removed once TS OSDK is updated to use `objectSets/aggregate` with interface object\nsets.\n:::\nPerform functions on object fields in the specified ontology and of the specified interface type. Any \nproperties specified in the query must be shared property type API names defined on the interface.\n","plainTextDescription":"This endpoint will be removed once TS OSDK is updated to use objectSets/aggregate with interface object\nsets.\n\nPerform functions on object fields in the specified ontology and of the specified interface type. Any\nproperties specified in the query must be shared property type API names defined on the interface.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate objects from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"aggregation":[{"type":"min","field":"tenure","name":"min_tenure"},{"type":"avg","field":"tenure","name":"avg_tenure"}],"where":{"type":"eq","field":"name","value":"john"},"groupBy":[{"field":"startDate","type":"range","ranges":[{"startValue":"2020-01-01","endValue":"2020-06-01"}]},{"field":"city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOutgoingInterfaceLinkTypes","verb":"listOutgoingInterfaceLinkTypes","documentation":{"description":"List the outgoing interface link types for an interface type.\n","plainTextDescription":"List the outgoing interface link types for an interface type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}/outgoingLinkTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingInterfaceLinkTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getOutgoingInterfaceLinkType","verb":"getOutgoingInterfaceLinkType","documentation":{"description":"Get an outgoing interface link type for an interface type.\n","plainTextDescription":"Get an outgoing interface link type for an interface type.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}/outgoingLinkTypes/{interfaceLinkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceLinkType","documentation":{"description":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the **Ontology Manager** page for the \nparent interface.\n","plainTextDescription":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the Ontology Manager page for the\nparent interface.","example":["worksAt"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listInterfaceLinkedObjects","verb":"listInterfaceLinkedObjects","documentation":{"description":"Lists the linked objects for a specific object and the given interface link type.\n\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\n\nNote that null value properties will not be returned.\n","plainTextDescription":"Lists the linked objects for a specific object and the given interface link type.\nNote that this endpoint does not guarantee consistency. Changes to the data could result in missing or\nrepeated objects in the response pages.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nEach page may be smaller or larger than the requested page size. However, it\nis guaranteed that if there are more results available, at least one result will be present\nin the response.\nNote that null value properties will not be returned.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/interfaces/{interfaceType}/{objectType}/{primaryKey}/links/{interfaceLinkType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"description":"The API name of the ontology. To find the API name, use the **List ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the ontology. To find the API name, use the List ontologies endpoint or\ncheck the Ontology Manager.","example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceType","documentation":{"description":"The API name of the interface type. To find the API name, use the **List interface types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the interface type. To find the API name, use the List interface types endpoint or\ncheck the Ontology Manager application.","example":["Employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"interfaceLinkType","documentation":{"description":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the **Ontology Manager** page for the \nparent interface.\n","plainTextDescription":"The API name of the outgoing interface link.\nTo find the API name for your interface link type, check the Ontology Manager page for the\nparent interface.","example":["worksAt"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"primaryKey","documentation":{"description":"The primary key of the object from which to **start** the interface link traversal. To look up the expected \nprimary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**.\n","plainTextDescription":"The primary key of the object from which to start the interface link traversal. To look up the expected\nprimary key for your object type, use the Get object type endpoint or the Ontology Manager.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 1,000.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 1,000.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"select","documentation":{"description":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.\n","plainTextDescription":"The properties of the object type that should be included in the response. Omit this parameter to get all\nthe properties.","example":[]},"inputType":"QUERY","type":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"orderBy","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"excludeRid","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"snapshot","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":50030,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":50030,"firstName":"John","lastName":"Doe"},{"$rid":"ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab","$primaryKey":20090,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","id":20090,"firstName":"John","lastName":"Haymore"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceLinkedObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Action represents one application of an action type. You may use them in the API to apply changes to the \nOntology. For more information, refer to the [action type](/docs/foundry/action-types/overview/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Action"},"pluralName":"Actions","operations":[{"name":"applyActionV2","verb":"apply","documentation":{"description":"Applies an action using the given parameters. \n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that a 200 HTTP status code only indicates that the request was received and processed by the server. \nSee the validation result in the response body to determine if the action was applied successfully.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n","plainTextDescription":"Applies an action using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that a 200 HTTP status code only indicates that the request was received and processed by the server.\nSee the validation result in the response body to determine if the action was applied successfully.\nNote that parameter default values are not currently supported by\nthis endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/apply","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to apply the action against.\n","plainTextDescription":"The resource identifier of an ontology scenario to apply the action against.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"operationId":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367","validation":{"result":"VALID"},"parameters":{"id":{"evaluatedConstraints":[],"result":"VALID","required":true},"newName":{"evaluatedConstraints":[],"result":"VALID","required":true}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]},{"name":"applyActionAsyncV2","verb":"applyAsync","documentation":{"description":"Applies an action using the given parameters. \n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n","plainTextDescription":"Applies an action using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nNote that parameter default values are not currently supported by\nthis endpoint.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyAsync","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"operationId":"ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponseV2"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"applyActionBatchV2","verb":"applyBatch","documentation":{"description":"Applies multiple actions (of the same Action Type) using the given parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\n\nNote that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint.\n","plainTextDescription":"Applies multiple actions (of the same Action Type) using the given parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\nNote that notifications are not currently supported by this endpoint.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"applyActionWithOverrides","verb":"applyWithOverrides","documentation":{"description":"Same as regular apply action operation, but allows specifying overrides for UniqueIdentifier and\nCurrentTime generated action parameters.\n","plainTextDescription":"Same as regular apply action operation, but allows specifying overrides for UniqueIdentifier and\nCurrentTime generated action parameters.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyWithOverrides","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to apply the action against.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to apply the action against.\n","plainTextDescription":"The resource identifier of an ontology scenario to apply the action against.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"request":{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},"overrides":{"uniqueIdentifierLinkIdValues":{"fd28fa5c-3028-4eca-bdc8-3be2c7949cd9":"4efdb11f-c1e3-417c-89fb-2225118b65e3"},"actionExecutionTime":"2025-10-25T13:00:00Z"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionWithOverridesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"validation":{"result":"VALID"},"parameters":{"id":{"evaluatedConstraints":[],"result":"VALID","required":true},"newName":{"evaluatedConstraints":[],"result":"VALID","required":true}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]},{"name":"applyActionBatchWithOverrides","verb":"applyBatchWithOverrides","documentation":{"description":"Applies multiple actions (of the same Action Type) with per-item overrides\nfor UniqueIdentifier and CurrentTime generated action parameters.\n\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\n\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\n\nNote that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint.\n","plainTextDescription":"Applies multiple actions (of the same Action Type) with per-item overrides\nfor UniqueIdentifier and CurrentTime generated action parameters.\nChanges to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible.\nEdits to objects or links in Object Storage V2 will be visible immediately after the action completes.\nUp to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not\ncall Functions may receive a higher limit.\nNote that notifications are not currently supported by this endpoint.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/actions/{action}/applyBatchWithOverrides","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"action","documentation":{"description":"The API name of the action to apply. To find the API name for your action, use the **List action types**\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The API name of the action to apply. To find the API name for your action, use the List action types\nendpoint or check the Ontology Manager.","example":["rename-employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to apply the action against. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"},"overrides":{"uniqueIdentifierLinkIdValues":{"fd28fa5c-3028-4eca-bdc8-3be2c7949cd9":"4efdb11f-c1e3-417c-89fb-2225118b65e3"},"actionExecutionTime":"2025-10-25T13:00:00Z"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionWithOverridesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using\n[Query Functions](/docs/foundry/functions/query-functions/).\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"QueryType"},"pluralName":"QueryTypes","operations":[{"name":"listQueryTypesV2","verb":"list","documentation":{"description":"Lists the query types for the given Ontology.\n\nEach query type is returned at its latest version. The latest version is the one that was most recently\npublished, which may be a pre-release version.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.\n","plainTextDescription":"Lists the query types for the given Ontology.\nEach query type is returned at its latest version. The latest version is the one that was most recently\npublished, which may be a pre-release version.\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queryTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to list queries from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to list queries from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The desired size of the page to be returned. Defaults to 100.\nSee [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details.\n","plainTextDescription":"The desired size of the page to be returned. Defaults to 100.\nSee page sizes for details.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"nextPageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z","data":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"dataType":{"type":"string"},"description":"The city to search for employees in","required":true}},"output":{"dataType":{"type":"array","required":true,"subType":{"type":"object","objectApiName":"Employee"}},"required":true},"rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"},{"apiName":"getAverageTenureOfEmployees","displayName":"Get Average Tenure","description":"Gets the average tenure of all employees","parameters":{"employees":{"dataType":{"type":"string"},"description":"An object set of the employees to calculate the average tenure of","required":true},"useMedian":{"dataType":{"type":"boolean"},"description":"An optional flag to use the median instead of the mean, defaults to false","required":false}},"output":{"dataType":{"type":"double"},"required":true},"rid":"ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400","version":"2.1.1"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getQueryTypeV2","verb":"get","documentation":{"description":"Gets a specific query type with the given API name.\n","plainTextDescription":"Gets a specific query type with the given API name.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queryTypes/{queryApiName}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the query type. To find the API name, use the **List query types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the query type. To find the API name, use the List query types endpoint or\ncheck the Ontology Manager.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"version","documentation":{"description":"The version of the Query to get. If not specified, the latest version is used. The latest version is\nthe one that was most recently published, including pre-release versions.\n","plainTextDescription":"The version of the Query to get. If not specified, the latest version is used. The latest version is\nthe one that was most recently published, including pre-release versions.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"getEmployeesInCity","displayName":"Get Employees in City","description":"Gets all employees in a given city","parameters":{"city":{"dataType":{"type":"string"},"description":"The city to search for employees in","required":true}},"output":{"dataType":{"type":"array","subType":{"type":"object","objectApiName":"Employee"}},"required":true},"rid":"ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b","version":"1.1.3-rc1"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getQueryTypeByRidBatch","verb":"getByRidBatch","documentation":{"description":"Gets a list of query types by RID in bulk.\n\nQuery types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\n\nThe maximum batch size for this endpoint is 100.\n","plainTextDescription":"Gets a list of query types by RID in bulk.\nQuery types are filtered from the response if they don't exist or the requesting token lacks the required\npermissions.\nThe maximum batch size for this endpoint is 100.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queryTypes/getByRidBatch","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the query type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the query type definitions from. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"A query type represents a logic that can be run in the Ontology. Query types can be created using\n[Query Functions](/docs/foundry/functions/query-functions/).\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Query"},"pluralName":"Queries","operations":[{"name":"executeQueryV2","verb":"execute","documentation":{"description":"Executes a Query using the given parameters. By default, the latest version of the Query is executed. \nThe latest version is the one that was most recently published, which may be a pre-release version.\n\nOptional parameters do not need to be supplied.\n","plainTextDescription":"Executes a Query using the given parameters. By default, the latest version of the Query is executed.\nThe latest version is the one that was most recently published, which may be a pre-release version.\nOptional parameters do not need to be supplied.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/queries/{queryApiName}/execute","httpMethod":"POST","parameters":[{"name":"attribution","documentation":{"description":"The Attribution to be used when executing this request.\n","plainTextDescription":"The Attribution to be used when executing this request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Attribution"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"queryApiName","documentation":{"description":"The API name of the Query to execute.\n","plainTextDescription":"The API name of the Query to execute.","example":["getEmployeesInCity"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"version","documentation":{"description":"The version of the Query to execute. If not specified, the latest version is used. The latest version\nis the one that was most recently published, including pre-release versions. When used\nwith `branch`, the specified version must exist on the branch.\n","plainTextDescription":"The version of the Query to execute. If not specified, the latest version is used. The latest version\nis the one that was most recently published, including pre-release versions. When used\nwith branch, the specified version must exist on the branch.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to execute the query from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\nWhen provided without `version`, the latest version on this branch is used, including pre-release versions.\nWhen provided with `version`, the specified version must exist on the branch.\n","plainTextDescription":"The Foundry branch to execute the query from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\nWhen provided without version, the latest version on this branch is used, including pre-release versions.\nWhen provided with version, the specified version must exist on the branch.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to execute the query on.\n","plainTextDescription":"The resource identifier of an ontology scenario to execute the query on.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parameters":{"city":"New York"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"value":["EMP546","EMP609","EMP989"]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false,"includeTraceContext":true},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An object set represents a set of objects in the Ontology. You can use object sets to perform operations on \nmultiple objects at once.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyObjectSet"},"pluralName":"OntologyObjectSets","operations":[{"name":"createTemporaryObjectSetV2","verb":"createTemporary","documentation":{"description":"Creates a temporary `ObjectSet` from the given definition. This `ObjectSet` expires after one hour.\n","plainTextDescription":"Creates a temporary ObjectSet from the given definition. This ObjectSet expires after one hour.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyLogicCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/createTemporary","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to reference. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to reference. If not specified, the default branch will be used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"base","objectType":"Employee"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"objectSetRid":"ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetResponseV2"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getObjectSetV2","verb":"get","documentation":{"description":"Gets the definition of the `ObjectSet` with the given RID.\n","plainTextDescription":"Gets the definition of the ObjectSet with the given RID.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyLogicAccess"],"auth":{"includeAuthHeader":true,"scopes":[],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/{objectSetRid}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"objectSetRid","documentation":{"description":"The RID of the object set.\n","plainTextDescription":"The RID of the object set.","example":["ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":{"objectSet":{"type":"base","objectType":"Employee"}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"loadObjectSetV2","verb":"load","documentation":{"description":"Load the ontology objects present in the `ObjectSet` from the provided object set definition.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nNote that null value properties will not be returned.\n\nVector properties will not be returned unless included in the `select` parameter.\n\nThe `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a `nextPageToken`, the remaining\nobjects can be retrieved by requesting subsequent pages.\n","plainTextDescription":"Load the ontology objects present in the ObjectSet from the provided object set definition.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nNote that null value properties will not be returned.\nVector properties will not be returned unless included in the select parameter.\nThe pageSize parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a nextPageToken, the remaining\nobjects can be retrieved by requesting subsequent pages.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadObjects","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object set from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object set from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to load the object set from.\n","plainTextDescription":"The resource identifier of an ontology scenario to load the object set from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"__rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851","__primaryKey":50030,"__apiName":"Employee","employeeId":50030,"firstName":"John","lastName":"Smith","age":21},{"__rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","__primaryKey":20090,"__apiName":"Employee","employeeId":20090,"firstName":"John","lastName":"Haymore","age":27}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"loadObjectSetV2MultipleObjectTypes","verb":"loadMultipleObjectTypes","documentation":{"description":"Load the ontology objects present in the `ObjectSet` from the provided object set definition. The resulting \nobjects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped \nto an interface, in which only the object type properties that implement the properties of any interfaces in its \nscope are returned. For objects that are scoped to an interface in the result, a mapping from interface to \nobject implementation is returned in order to interpret the objects as the interfaces that they implement.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in `loadObjects`.\n\nVector properties will not be returned unless included in the `select` parameter.\n\nThe `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a `nextPageToken`, the remaining\nobjects can be retrieved by requesting subsequent pages.\n","plainTextDescription":"Load the ontology objects present in the ObjectSet from the provided object set definition. The resulting\nobjects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped\nto an interface, in which only the object type properties that implement the properties of any interfaces in its\nscope are returned. For objects that are scoped to an interface in the result, a mapping from interface to\nobject implementation is returned in order to interpret the objects as the interfaces that they implement.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in loadObjects.\nVector properties will not be returned unless included in the select parameter.\nThe pageSize parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a nextPageToken, the remaining\nobjects can be retrieved by requesting subsequent pages.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the object set for multiple object types. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to load the object set from.\n","plainTextDescription":"The resource identifier of an ontology scenario to load the object set from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"base","objectType":"Employee"},"pageSize":10000,"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"$rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851","$primaryKey":50030,"$apiName":"Employee","employeeId":50030,"employeeName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":20090,"$apiName":"Employee","employeeId":20090,"employeeName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b71","$primaryKey":23,"$apiName":"Athlete","jerseyNumber":23,"firstName":"Michael"}],"totalCount":"3,","interfaceToObjectTypeMappings":{"Person":{"Employee":{"first":"employeeName","identifier":"employeeId"},"Athlete":{"first":"firstName","identifier":"jerseyNumber"}}}}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"loadObjectSetV2ObjectsOrInterfaces","verb":"loadObjectsOrInterfaces","documentation":{"description":"Load the ontology objects present in the `ObjectSet` from the provided object set definition. If the requested \nobject set contains interfaces and the object can be viewed as an interface, it will contain the properties \ndefined by the interface. If not, it will contain the properties defined by its object type. This allows directly\nloading all objects of an interface where all objects are viewed as the interface, for example.\n\nNote that the result object set cannot contain a mix of objects with \"interface\" properties and \"object type\"\nproperties. Attempting to load an object set like this will result in an error.\n\nFor 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\nare available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects.\n\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in `/loadObjects`.\n\nVector properties will not be returned unless included in the `select` parameter.\n\nThe `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a `nextPageToken`, the remaining\nobjects can be retrieved by requesting subsequent pages.\n","plainTextDescription":"Load the ontology objects present in the ObjectSet from the provided object set definition. If the requested\nobject set contains interfaces and the object can be viewed as an interface, it will contain the properties\ndefined by the interface. If not, it will contain the properties defined by its object type. This allows directly\nloading all objects of an interface where all objects are viewed as the interface, for example.\nNote that the result object set cannot contain a mix of objects with \"interface\" properties and \"object type\"\nproperties. Attempting to load an object set like this will result in an error.\nFor 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\nare available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.\nNote that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey)\nwill be prefixed with '$' instead of '__' as is the case in /loadObjects.\nVector properties will not be returned unless included in the select parameter.\nThe pageSize parameter is a maximum. A page may contain fewer objects than requested if the\nobjects in the page are large enough to reach an internal memory limit; this does not indicate\nthat there are no more results. As long as the response contains a nextPageToken, the remaining\nobjects can be retrieved by requesting subsequent pages.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to load the objects or interfaces from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to load the objects or interfaces from.\n","plainTextDescription":"The resource identifier of an ontology scenario to load the objects or interfaces from.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"type":"interfaceBase","interfaceType":"Person"},"pageSize":10000,"pageToken":"v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"$rid":"ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851","$primaryKey":50030,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","personId":50030,"firstName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61","$primaryKey":20090,"$objectTypeApiName":"Employee","$interfaceTypeApiName":"Person","personID":20090,"firstName":"John"},{"$rid":"ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b71","$primaryKey":23,"$objectTypeApiName":"Athlete","$interfaceTypeApiName":"Person","personId":23,"firstName":"Michael"}],"totalCount":3}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"aggregateObjectSetV2","verb":"aggregate","documentation":{"description":"Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition.\n","plainTextDescription":"Aggregates the ontology objects present in the ObjectSet from the provided object set definition.","example":[]},"releaseStage":"STABLE","auditCategories":["ontologyDataSearch"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/aggregate","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of an Ontology transaction to read from.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The resource identifier of an ontology scenario to aggregate the objects on.\n","plainTextDescription":"The resource identifier of an ontology scenario to aggregate the objects on.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"objectType":"Employee","type":"base"},"aggregation":[{"field":"tenure","name":"min_tenure","type":"min"},{"field":"tenure","name":"avg_tenure","type":"avg"}],"groupBy":[{"field":"startDate","ranges":[{"endValue":"2020-06-01","startValue":"2020-01-01"}],"type":"range"},{"field":"city","type":"exact"}]}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectSetRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"metrics":[{"name":"min_tenure","value":1},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"New York City"}},{"metrics":[{"name":"min_tenure","value":2},{"name":"avg_tenure","value":3}],"group":{"startDate":{"startValue":"2020-01-01","endValue":"2020-06-01"},"city":"San Francisco"}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]},{"name":"loadObjectSetLinksV2","verb":"loadLinks","documentation":{"description":"Loads the specified links from the defined object set. \n\nLinks are defined as a link type API name and object locators for the source and target objects\nwhere only the `__primaryKey` and `__apiName` properties are loaded.\n\nLinks are grouped by source object locator; however, the links for a given source object may be\nsplit over multiple entries with the same source object locator.\n\nPlease keep these limitations in mind:\n- Links returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\n- This endpoint requests links for 1,000 objects at a time. If, for any page of 1,000 objects, there are more\n than 100,000 links present, results are limited to 100,000 links and should be considered partial.\n- This endpoint does not support OSv1 links and will return an error if links provided are backed by OSv1.\n- This endpoint currently does not support interface object sets or interface links, but support will be added in the near future.\n","plainTextDescription":"Loads the specified links from the defined object set.\nLinks are defined as a link type API name and object locators for the source and target objects\nwhere only the __primaryKey and __apiName properties are loaded.\nLinks are grouped by source object locator; however, the links for a given source object may be\nsplit over multiple entries with the same source object locator.\nPlease keep these limitations in mind:\n\nLinks returned may be stale. For example, primary keys returned by this endpoint may not exist anymore.\nThis endpoint requests links for 1,000 objects at a time. If, for any page of 1,000 objects, there are more\nthan 100,000 links present, results are limited to 100,000 links and should be considered partial.\nThis endpoint does not support OSv1 links and will return an error if links provided are backed by OSv1.\nThis endpoint currently does not support interface object sets or interface links, but support will be added in the near future.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/objectSets/loadLinks","httpMethod":"POST","parameters":[{"name":"traceParent","documentation":{"description":"The W3C trace parent header included in the request.\n","plainTextDescription":"The W3C trace parent header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"traceState","documentation":{"description":"The W3C trace state header included in the request.\n","plainTextDescription":"The W3C trace state header included in the request.","example":[]},"inputType":"HEADER","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TraceState"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The package version of the generated SDK.\n","plainTextDescription":"The package version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"branch","documentation":{"description":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.\n","plainTextDescription":"The Foundry branch to aggregate the objects from. If not specified, the default branch is used.\nBranches are an experimental feature and not all workflows are supported.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"executeInMemoryOnly","documentation":{"description":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\n\nDefaults to false.\n","plainTextDescription":"If true, the request fails with an error when it cannot be computed in-memory.\nUse this to opt into fast failure on requests that would otherwise require\nheavier computation.\nDefaults to false.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"objectSet":{"objectType":"Employee","type":"base"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksResponseV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":true},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An Attachment is a file that acts like a parameter of an object. Attachments are uploaded as temporary files \nand attached to objects via actions. Attachments are configured in the **Ontology Manager**. For more information, \nplease checkout the [Upload attachments](/docs/foundry/action-types/upload-attachments/) user documentation.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"Attachment"},"pluralName":"Attachments","operations":[{"name":"uploadAttachmentV2","verb":"upload","documentation":{"description":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n","plainTextDescription":"Upload an attachment to use in an action. Any attachment which has not been linked to an object via\nan action within one hour after upload will be removed.\nPreviously mapped attachments which are not connected to any object anymore are also removed on\na biweekly basis.\nThe body of the request must contain the binary content of the file and the Content-Type header must be application/octet-stream.","example":[]},"releaseStage":"STABLE","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/upload","httpMethod":"POST","parameters":[{"name":"Content-Length","documentation":{"description":"The size in bytes of the file content being uploaded.","plainTextDescription":"The size in bytes of the file content being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentLength"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Type","documentation":{"description":"The media type of the file being uploaded.","plainTextDescription":"The media type of the file being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentType"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"The name of the file being uploaded.","plainTextDescription":"The name of the file being uploaded.","example":["My Image.jpeg"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"uploadAttachmentWithRid","verb":"uploadWithRid","documentation":{"description":"This endpoint is identical to `/v2/ontologies/attachments/upload` but additionally accepts a previously\ngenerated `AttachmentRid`.\n","plainTextDescription":"This endpoint is identical to /v2/ontologies/attachments/upload but additionally accepts a previously\ngenerated AttachmentRid.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/upload/{attachmentRid}","httpMethod":"POST","parameters":[{"name":"attachmentRid","documentation":{"description":"The `AttachmentRid` of the attachment being uploaded.","plainTextDescription":"The AttachmentRid of the attachment being uploaded.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Length","documentation":{"description":"The size in bytes of the file content being uploaded.","plainTextDescription":"The size in bytes of the file content being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentLength"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"Content-Type","documentation":{"description":"The media type of the file being uploaded.","plainTextDescription":"The media type of the file being uploaded.","example":[]},"inputType":"HEADER","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ContentType"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"filename","documentation":{"description":"The name of the file being uploaded.","plainTextDescription":"The name of the file being uploaded.","example":["My Image.jpeg"]},"inputType":"QUERY","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"binary","binary":{"mediaType":"*/*"}}},"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentContentV2","verb":"read","documentation":{"description":"Get the content of an attachment.\n","plainTextDescription":"Get the content of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["dataExport"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/{attachmentRid}/content","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"binary","binary":{"mediaType":"*/*"}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"getAttachmentV2","verb":"get","documentation":{"description":"Get the metadata of an attachment.\n","plainTextDescription":"Get the metadata of an attachment.","example":[]},"releaseStage":"STABLE","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/attachments/{attachmentRid}","httpMethod":"GET","parameters":[{"name":"attachmentRid","documentation":{"description":"The RID of the attachment.","plainTextDescription":"The RID of the attachment.","example":["ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"rid":"ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f","filename":"My Image.jpeg","sizeBytes":393469,"mediaType":"image/jpeg"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"[Value types](/docs/foundry/object-link-types/value-types-overview/) are custom types that add semantic meaning and constraints to Foundry data.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyValueType"},"pluralName":"OntologyValueTypes","operations":[{"name":"getOntologyValueType","verb":"get","documentation":{"description":"Gets a specific value type with the given API name.\n","plainTextDescription":"Gets a specific value type with the given API name.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/valueTypes/{valueType}","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"valueType","documentation":{"description":"The API name of the value type. To find the API name, use the **List value types** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name of the value type. To find the API name, use the List value types endpoint or\ncheck the Ontology Manager.","example":["countryCode"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"apiName":"countryInitials","description":"A three letter code for a top-level administrative region","displayName":"Country Initials","status":"ACTIVE","fieldType":"string","rid":"ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c719d","constraints":[{"type":"length","length":{"minimumLength":3,"maximumLength":3}}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listOntologyValueTypes","verb":"list","documentation":{"description":"Lists the latest versions of the value types for the given Ontology.\n","plainTextDescription":"Lists the latest versions of the value types for the given Ontology.","example":[]},"releaseStage":"PUBLIC_BETA","auditCategories":["ontologyMetaDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/valueTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[{"data":[{"apiName":"validNorthAmericanCountries","description":"Options for valid countries in North America","displayName":"Valid North American Countries","status":"ACTIVE","fieldType":"string","rid":"ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c719d","constraints":[{"type":"enum","enum":{"options":["USA","Mexico","Canada"]}}]},{"apiName":"countyCode","description":"A three letter code for a US County.","displayName":"County Code","status":"ACTIVE","fieldType":"string","rid":"ri.type-registry.main.value-type.f5ee06ef-6dfd-4d91-a01e-91bd457c8232","constraints":[{"type":"length","length":{"minimumLength":3,"maximumLength":3}}]}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListOntologyValueTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"Transactions contain a set of edits to objects and links that can be applied to the ontology,\nsimilar to applying an action. You can use a transaction to perform read operations that reflect the proposed edits,\nand stage all edits at once to the ontology. Currently, Transaction RIDs can only be used from\nwithin functions backing actions.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyTransaction"},"pluralName":"OntologyTransactions","operations":[{"name":"ontologyTransactionPostEdits","verb":"postEdits","documentation":{"description":"Applies a set of edits to a transaction in order.\n","plainTextDescription":"Applies a set of edits to a transaction in order.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataTransform"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/transactions/{transactionId}/edits","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"transactionId","documentation":{"description":"The ID of the transaction to apply edits to.\nTransactions are an experimental feature and all workflows may not be supported.\n","plainTextDescription":"The ID of the transaction to apply edits to.\nTransactions are an experimental feature and all workflows may not be supported.","example":[]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkPackageRid","documentation":{"description":"The package rid of the generated SDK.\n","plainTextDescription":"The package rid of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"sdkVersion","documentation":{"description":"The version of the generated SDK.\n","plainTextDescription":"The version of the generated SDK.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Transaction edits were applied successfully.","plainTextDescription":"Transaction edits were applied successfully.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]},{"singleton":false,"documentation":{"description":"An OntologyScenario represents a sandboxed data-fork of the ontology, allowing you to conduct simulations on your\nontology without affecting production data. You can create scenarios, perform read and write actions on the scenario,\nand merge the changes on the scenario back to the ontology.\n","example":[]},"component":{"namespaceName":"Ontologies","localName":"OntologyScenario"},"pluralName":"OntologyScenarios","operations":[{"name":"createOntologyScenario","verb":"createScenario","documentation":{"description":"Creates an ontology scenario.\n","plainTextDescription":"Creates an ontology scenario.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyLogicCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read","api:ontologies-write"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/create","httpMethod":"POST","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"base":{"type":"branch","branch":"my-branch"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"Successfully created a scenario.","plainTextDescription":"Successfully created a scenario.","example":[{"scenarioRid":"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedObjectTypes","verb":"listScenarioEditedObjectTypes","documentation":{"description":"Returns the list of object type API names that have been modified within a given scenario.\n","plainTextDescription":"Returns the list of object type API names that have been modified within a given scenario.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objectTypes/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedLinkTypes","verb":"listScenarioEditedLinkTypes","documentation":{"description":"Returns the list of outgoing links that have been modified within a given scenario for an object type.\n\nNote that only many-to-many link type are returned by this endpoint. One-to-many link type edits are\nsurfaced as object edits on the object type that owns the foreign key property.\n","plainTextDescription":"Returns the list of outgoing links that have been modified within a given scenario for an object type.\nNote that only many-to-many link type are returned by this endpoint. One-to-many link type edits are\nsurfaced as object edits on the object type that owns the foreign key property.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objectTypes/{objectType}/outgoingLinkTypes/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type. To find the API name, use the **List object types** endpoint or\ncheck the **Ontology Manager** application.\n","plainTextDescription":"The API name of the object type. To find the API name, use the List object types endpoint or\ncheck the Ontology Manager application.","example":["Flight"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinkTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedEntityTypes","verb":"listScenarioEditedEntityTypes","documentation":{"description":"Returns the object types and link types that have been modified within a given scenario.\n\nThe response contains the list of object type API names that have been modified, and the list of\nmany-to-many link types that have been modified, grouped by their source object type. One-to-many\nlink type edits are surfaced as object edits on the object type that owns the foreign key property.\n","plainTextDescription":"Returns the object types and link types that have been modified within a given scenario.\nThe response contains the list of object type API names that have been modified, and the list of\nmany-to-many link types that have been modified, grouped by their source object type. One-to-many\nlink type edits are surfaced as object edits on the object type that owns the foreign key property.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/editedEntityTypes","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedEntityTypesResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedObjects","verb":"listScenarioEditedObjects","documentation":{"description":"Returns the list of objects that have been edited within a given scenario for a specific object type.\nOnly objects that the user has permission to view are returned.\n\nEach page may be smaller than the requested page size.\n","plainTextDescription":"Returns the list of objects that have been edited within a given scenario for a specific object type.\nOnly objects that the user has permission to view are returned.\nEach page may be smaller than the requested page size.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type.\n","plainTextDescription":"The API name of the object type.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The maximum number of objects to return per page.\n","plainTextDescription":"The maximum number of objects to return per page.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"description":"The page token to use for pagination.\n","plainTextDescription":"The page token to use for pagination.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioEditedLinks","verb":"listScenarioEditedLinks","documentation":{"description":"Returns the list of edited links within a given scenario for a specific object type and link type, grouped\nby source object. Only works for many-to-many link types. Only links where the user has permission to view\nboth objects are returned.\n\nEach page may be smaller than the requested page size.\n","plainTextDescription":"Returns the list of edited links within a given scenario for a specific object type and link type, grouped\nby source object. Only works for many-to-many link types. Only links where the user has permission to view\nboth objects are returned.\nEach page may be smaller than the requested page size.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/links/{linkType}/edited","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type.\n","plainTextDescription":"The API name of the object type.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"linkType","documentation":{"description":"The API name of the link type.\n","plainTextDescription":"The API name of the link type.","example":["employeeReportsTo"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The maximum number of links to return per page.\n","plainTextDescription":"The maximum number of links to return per page.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"description":"The page token to use for pagination.\n","plainTextDescription":"The page token to use for pagination.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinksResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]},{"name":"listScenarioConflictingObjects","verb":"listScenarioConflictingObjects","documentation":{"description":"Returns the list of objects with edits that conflict with edits to the scenario's base for a specific object\ntype. A conflict occurs when an object has been edited both within the scenario and on the scenario's base\nafter the scenario was created. Only objects that the user has permission to view are returned.\n\nConflict detection takes into account changes that are not reflected in the user-visible object data.\nAs a result, this endpoint may report false positives. An object may be returned as conflicting even if\nits data has not actually changed on the scenario's base.\n\nEach page may be smaller than the requested page size.\n","plainTextDescription":"Returns the list of objects with edits that conflict with edits to the scenario's base for a specific object\ntype. A conflict occurs when an object has been edited both within the scenario and on the scenario's base\nafter the scenario was created. Only objects that the user has permission to view are returned.\nConflict detection takes into account changes that are not reflected in the user-visible object data.\nAs a result, this endpoint may report false positives. An object may be returned as conflicting even if\nits data has not actually changed on the scenario's base.\nEach page may be smaller than the requested page size.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["ontologyDataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:ontologies-read"],"expandedScopes":[]},"http":{"path":"/v2/ontologies/{ontology}/scenarios/{scenarioRid}/objects/{objectType}/conflicting","httpMethod":"GET","parameters":[{"name":"ontology","documentation":{"example":["palantir"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"scenarioRid","documentation":{"description":"The unique resource identifier of the scenario.\n","plainTextDescription":"The unique resource identifier of the scenario.","example":["ri.actions..scenario.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"objectType","documentation":{"description":"The API name of the object type.\n","plainTextDescription":"The API name of the object type.","example":["employee"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"pageSize","documentation":{"description":"The maximum number of objects to examine when searching for conflicts. This bounds the work performed\nper call; it is not a guarantee on the number of conflicting objects returned, which may be smaller.\nEach page may be smaller than this value.\n","plainTextDescription":"The maximum number of objects to examine when searching for conflicts. This bounds the work performed\nper call; it is not a guarantee on the number of conflicting objects returned, which may be smaller.\nEach page may be smaller than this value.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"pageToken","documentation":{"description":"The page token to use for pagination.\n","plainTextDescription":"The page token to use for pagination.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"A boolean flag that, when set to true, enables the use of beta features in preview mode.\n","plainTextDescription":"A boolean flag that, when set to true, enables the use of beta features in preview mode.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"description":"Success response.","plainTextDescription":"Success response.","example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioConflictingObjectsResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"},"conjureServerAsync":false,"conjureRequestContext":false},"throwableErrors":[]}]}],"components":[{"locator":{"namespaceName":"Ontologies","localName":"TableRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry table.","plainTextDescription":"The RID of a Foundry table.","example":["ri.tables.main.table.beb574f7-019c-4a01-abd1-ff3c97bfaec8"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"}}}},"prefix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"}}}},"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"}}}},"allTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"}}}},"phrase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"}}}},"anyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface property implementations of that object type.","plainTextDescription":"Map from object type to the interface property implementations of that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of an input to a function.\n","plainTextDescription":"The name of an input to a function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the property is backed by a restricted view that does not support property securities.","plainTextDescription":"Indicates the property is backed by a restricted view that does not support property securities.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"},"type":{"type":"object","object":{"properties":{"center":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"}}},"safety":"UNSAFE","documentation":{"example":[]}},"distance":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Distance"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The coordinate point to use as the center of the distance query.\n","plainTextDescription":"The coordinate point to use as the center of the distance query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeReferences":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a parameter against the configured constraints.","plainTextDescription":"Represents the validity of a parameter against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the PropertyType","plainTextDescription":"The API name of the PropertyType","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"},"type":{"type":"object","object":{"properties":{"position":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Position"}}},"safety":"UNSAFE","documentation":{"example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The underlying data values pointed to by a GeotimeSeriesReference.","plainTextDescription":"The underlying data values pointed to by a GeotimeSeriesReference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current time argument in a logic rule.","plainTextDescription":"Represents the current time argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionMode"},"type":{"type":"enum","enum":{"values":["ASYNC","RUN","VALIDATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types that have been modified within a scenario.\n","plainTextDescription":"The object types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an approximate number of distinct values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","plainTextDescription":"ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadOntologyMetadataRequest"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","plainTextDescription":"The Ontology metadata (i.e., object, link, action, query, and interface types) to load.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version corresponding to a codex template.","plainTextDescription":"The version corresponding to a codex template.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have been edited within the scenario.","plainTextDescription":"The list of objects that have been edited within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have been edited within a scenario for a given object type.\n\nThe Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName`\nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The objects that have been edited within a scenario for a given object type.\nThe Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between the intervals produced by the sub-rules. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched intervals must occur in order.","plainTextDescription":"If true, the matched intervals must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying all the rules in the query\n","plainTextDescription":"Matches intervals satisfying all the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a struct field in the Ontology.","plainTextDescription":"The name of a struct field in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"timeSeriesSyncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the time series.\n","plainTextDescription":"The set of properties that are bound to the time series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a time series sync, providing values for time-dependent properties.\n","plainTextDescription":"An object type datasource backed by a time series sync, providing values for time-dependent properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyFullMetadata"},"type":{"type":"object","object":{"properties":{"ontology":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"queryTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BranchMetadata"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with an api name matching the given string predicate.","plainTextDescription":"Returns action types with an api name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`.","plainTextDescription":"Represents the API POST body when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequest"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","plainTextDescription":"The parameter value (a markdown-formatted string) must satisfy the configured length bounds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed \"Other\" value** toggle in the **Ontology Manager**.","plainTextDescription":"A flag denoting whether custom, user provided values will be considered valid. This is configured via the Allowed \"Other\" value toggle in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter has a manually predefined set of options.\n","plainTextDescription":"The parameter has a manually predefined set of options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Greater than or equal.","plainTextDescription":"Greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Less than or equal.","plainTextDescription":"Less than or equal.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Bounds on the size of an array-typed parameter.","plainTextDescription":"Bounds on the size of an array-typed parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"style":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"}}},"safety":"SAFE","documentation":{"example":[]}},"currencyCode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)\n","plainTextDescription":"Format numbers as currency values with proper symbols and styling.\nExample: 1234.56 with currency \"USD\" displays as \"USD 1,234.56\" (standard) or \"USD 1.2K\" (compact)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"},"type":{"type":"object","object":{"properties":{"directSourceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the direct datasource.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.\n","plainTextDescription":"An object type datasource backed by a direct-write source. Property values are written directly to the\ndatasource rather than being read from a separate Foundry resource. Unlike an edits-only datasource, a direct\ndatasource has a backing source that values are written to by some writer. An edits-only datasource has no\nbacking source at all and its properties are populated solely via Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Parameter"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action or query.","plainTextDescription":"Details about a parameter of an action or query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter`, whose value type is\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that merges the edits accumulated on a referenced Scenario into the ontology data context\nwhere the Action is applied. If the Action is applied against another Scenario, the edits are merged into\nthat target Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter, whose value type is\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"},"type":{"type":"object","object":{"properties":{"numberType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Wrapper for numeric formatting options.","plainTextDescription":"Wrapper for numeric formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the minimum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.\n","plainTextDescription":"A property on an object type that is permissioned to a tabular datasource, but the contents are only populated through Actions.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A message containing link updates for a subscription.","plainTextDescription":"A message containing link updates for a subscription.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"description":"The numeric value of the time offset. Negative values indicate the past, positive values the future.\n","plainTextDescription":"The numeric value of the time offset. Negative values indicate the past, positive values the future.","example":[-7]}},"timeUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"}}},"safety":"SAFE","documentation":{"description":"The unit of time for the value.","plainTextDescription":"The unit of time for the value.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A point in time specified relative to query execution time.","plainTextDescription":"A point in time specified relative to query execution time.","example":[{"value":-7,"timeUnit":"DAY"}]}},{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they are revertible.","plainTextDescription":"Returns action types based on whether they are revertible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"},"type":{"type":"enum","enum":{"values":["STANDARD","SCIENTIFIC","ENGINEERING","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Number notation style options:\n- STANDARD: Regular number display (\"1,234\")\n- SCIENTIFIC: Scientific notation (\"1.234E3\")\n- ENGINEERING: Engineering notation (\"1.234E3\")\n- COMPACT: Compact notation (\"1.2K\")\n","plainTextDescription":"Number notation style options:\n\nSTANDARD: Regular number display (\"1,234\")\nSCIENTIFIC: Scientific notation (\"1.234E3\")\nENGINEERING: Engineering notation (\"1.234E3\")\nCOMPACT: Compact notation (\"1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the property in the API. To find the API name for your property, use the `Get object type`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the property in the API. To find the API name for your property, use the Get object type\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"description":"The suggested visibility of the object type.","plainTextDescription":"The suggested visibility of the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Represents a filter used on properties.\n\nEndpoints that accept this supports optional parameters that have the form:\n`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects.\nFor instance, you may use `properties.firstName.eq=John` to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\n\nThe following are a list of supported property filters:\n\n- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties\n that have at least one of the provided values. If multiple query parameters are provided, then objects\n that have any of the given values for the specified property will be matched.\n- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided\n property. If multiple query parameters are provided, then objects that have any of the given values\n will be matched. For instance, if the user provides a request by doing\n `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property\n of either John or Anna will be matched. This filter is supported on all property types except Arrays.\n- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values.\n Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values\n will be excluded from the result.\n- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt`\n `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater\n than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\n- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null.\n This filter is supported on all property types.\n","plainTextDescription":"Represents a filter used on properties.\nEndpoints that accept this supports optional parameters that have the form:\nproperties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString} to filter the returned objects.\nFor instance, you may use properties.firstName.eq=John to find objects that contain a property called\n\"firstName\" that has the exact value of \"John\".\nThe following are a list of supported property filters:\n\nproperties.{propertyApiName}.contains - supported on arrays and can be used to filter array properties\nthat have at least one of the provided values. If multiple query parameters are provided, then objects\nthat have any of the given values for the specified property will be matched.\nproperties.{propertyApiName}.eq - used to filter objects that have the exact value for the provided\nproperty. If multiple query parameters are provided, then objects that have any of the given values\nwill be matched. For instance, if the user provides a request by doing\n?properties.firstName.eq=John&properties.firstName.eq=Anna, then objects that have a firstName property\nof either John or Anna will be matched. This filter is supported on all property types except Arrays.\nproperties.{propertyApiName}.neq - used to filter objects that do not have the provided property values.\nSimilar to the eq filter, if multiple values are provided, then objects that have any of the given values\nwill be excluded from the result.\nproperties.{propertyApiName}.lt, properties.{propertyApiName}.lte, properties.{propertyApiName}.gt\nproperties.{propertyApiName}.gte - represent less than, less than or equal to, greater than, and greater\nthan or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal.\nproperties.{propertyApiName}.isNull - used to filter objects where the provided property is (or is not) null.\nThis filter is supported on all property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Icon"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"blueprint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","plainTextDescription":"A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \n \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the derived property that will be returned.\n","plainTextDescription":"The name of the derived property that will be returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Ontology"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the `List shared property types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the shared property type in the API in lowerCamelCase format. To find the API name for your\nshared property type, use the List shared property types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the webhook with the given rid.","plainTextDescription":"Returns action types which reference the webhook with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only *properties*, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.\n","plainTextDescription":"An object type datasource that is not backed by any external Foundry resource. All properties on the object type\ncan only be populated via Actions. Other datasources have edit only properties, which are permissioned to the\nbacking tabular datasource. This datasource has no backing tabular datasource and is a true edit only object\ntype. Note that this datasource type is incompatible with any other datasource and all the properties on the\nobject type are backed by it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about an Ontology.","plainTextDescription":"Metadata about an Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioRequest"},"type":{"type":"object","object":{"properties":{"base":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for creating an ontology scenario.","plainTextDescription":"The request payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"allOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AllOfRule"}}}},"match":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"}}}},"anyOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"}}}},"prefixOnLastToken":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"}}}},"fuzzy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Sub-rule used for evaluating an IntervalQuery","plainTextDescription":"Sub-rule used for evaluating an IntervalQuery","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a \nvariety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified array contains a value. Allows you to specify a property to query on by a\nvariety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A reference to an Ontology object property with the form `properties.{propertyApiName}`.","plainTextDescription":"A reference to an Ontology object property with the form properties.{propertyApiName}.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A reference to a UniqueIdentifierArgument linkId defined for this action type.\n","plainTextDescription":"A reference to a UniqueIdentifierArgument linkId defined for this action type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the action type in the API. To find the API name for your Action Type, use the `List action types`\nendpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the action type in the API. To find the API name for your Action Type, use the List action types\nendpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItemWithOverrides"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"},"type":{"type":"object","object":{"properties":{"shouldLoadObjectRids":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of \nmilliseconds to the execution time, and should be avoided where not needed.\n","plainTextDescription":"Whether returned objects should include their RIDs. Note that resolving object RIDs can add 100s of\nmilliseconds to the execution time, and should be avoided where not needed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Optional features to toggle when generating the object loading response.\n","plainTextDescription":"Optional features to toggle when generating the object loading response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"},"type":{"type":"object","object":{"properties":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}},"tense":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A datetime expressed as an offset from the current time.","plainTextDescription":"A datetime expressed as an offset from the current time.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.\n","plainTextDescription":"The vector to search with. The vector must be of the same dimension as the vectors stored in the provided\npropertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceObjectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructType"},"type":{"type":"object","object":{"properties":{"structFieldTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"mainValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A single struct field's mapping where `apiName` is the name of a struct field.\n","plainTextDescription":"A single struct field's mapping where apiName is the name of a struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"}}}},"user":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a parameter whose name matches the given string predicate.","plainTextDescription":"Returns action types with a parameter whose name matches the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"},"type":{"type":"object","object":{"properties":{"formatStyle":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"}}},"safety":"UNSAFE","documentation":{"example":[]}},"precision":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"}}}}},"safety":"SAFE","documentation":{"example":[]}},"baseValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numeric values representing time durations.\n- Human readable: 3661 seconds displays as \"1h 1m 1s\"\n- Timecode: 3661 seconds displays as \"01:01:01\"\n","plainTextDescription":"Format numeric values representing time durations.\n\nHuman readable: 3661 seconds displays as \"1h 1m 1s\"\nTimecode: 3661 seconds displays as \"01:01:01\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be within the defined range.\n","plainTextDescription":"The parameter value must be within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"},"type":{"type":"object","object":{"properties":{"objectApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set \nby removing the request from subsequent ObjectSetStreamSubscribeRequests.\n","plainTextDescription":"The list of object sets that should be subscribed to. A client can stop subscribing to an object set\nby removing the request from subsequent ObjectSetStreamSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object locators to report link changes on.","plainTextDescription":"A list of object locators to report link changes on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayTimezone":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezone"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for timestamp property values.","plainTextDescription":"Formatting configuration for timestamp property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"Map from object type to the interface-to-object-type mapping for that object type.","plainTextDescription":"Map from object type to the interface-to-object-type mapping for that object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"},"type":{"type":"enum","enum":{"values":["DAYS","MONTHS","QUARTERS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Negates a numeric value.\n","plainTextDescription":"Negates a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values of the object at the time of creation.\nMaps property API names to their values.\n","plainTextDescription":"The property values of the object at the time of creation.\nMaps property API names to their values.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObjectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`foreignKeyPropertyApiName` is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.\n","plainTextDescription":"foreignKeyPropertyApiName is the API name of the foreign key on this object type. If absent, the link is\neither a m2m link or the linked object has the foreign key and this object type has the primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"scenarioReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ScenarioReferenceType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"geohash":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeohashType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Action parameters.\n","plainTextDescription":"A union of all the types supported by Ontology Action parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid UUID (Universally Unique Identifier).","plainTextDescription":"The string must be a valid UUID (Universally Unique Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"},"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\n`List ontologies` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the\nList ontologies endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"rolling":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"}}}},"periodic":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"}}}},"cumulative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.\n","plainTextDescription":"CUMULATIVE aggregates all points up to the current point.\nROLLING aggregates all points in a rolling window whose size is either the specified number of points or\ntime duration.\nPERIODIC aggregates all points in specified time windows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.\n","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to how it is implemented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"structField":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"}}}},"propertyWithLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"}}}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"}}}},"primaryKeyProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An identifier used to select properties or struct fields.","plainTextDescription":"An identifier used to select properties or struct fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified numeric range.\n","plainTextDescription":"The parameter value must fall within the specified numeric range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Randomly generated identifier for an object type's datasource.\n","plainTextDescription":"Randomly generated identifier for an object type's datasource.","example":["ri.ontology.main.datasource.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"},"type":{"type":"object","object":{"properties":{"selectedObjects":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocators"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.\n","plainTextDescription":"A request to subscribe to link changes from a selected side of a set of objects over a set of link\ntypes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"},"type":{"type":"object","object":{"properties":{"minimumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"uniqueValues":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"valueConstraint":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"structFields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a singleton struct parameter.","plainTextDescription":"Represents the validity of a singleton struct parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponse"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the property values of the object.","plainTextDescription":"A map of the property values of the object.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleVector"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Queries support either a vector matching the embedding model defined on the property, or text that is \nautomatically embedded.\n","plainTextDescription":"Queries support either a vector matching the embedding model defined on the property, or text that is\nautomatically embedded.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The property API name to filter on (either field or propertyIdentifier must be provided).","plainTextDescription":"The property API name to filter on (either field or propertyIdentifier must be provided).","example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The property identifier to filter on (either field or propertyIdentifier must be provided).","plainTextDescription":"The property identifier to filter on (either field or propertyIdentifier must be provided).","example":[]}},"relativeStartTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"description":"The lower bound relative to query time (inclusive). Negative values go into the past.\nFor example, { value: -7, timeUnit: DAY } means 7 days ago.\n","plainTextDescription":"The lower bound relative to query time (inclusive). Negative values go into the past.\nFor example, { value: -7, timeUnit: DAY } means 7 days ago.","example":[]}},"relativeEndTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"}}}}},"safety":"UNSAFE","documentation":{"description":"The upper bound relative to query time (exclusive). Negative values go into the past.\nFor example, { value: 1, timeUnit: MONTH } means the start of next month.\n","plainTextDescription":"The upper bound relative to query time (exclusive). Negative values go into the past.\nFor example, { value: 1, timeUnit: MONTH } means the start of next month.","example":[]}},"timeZoneId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.\n","plainTextDescription":"Time zone ID for midnight calculation (e.g., \"America/New_York\", \"Europe/London\", \"Etc/UTC\").\nSee https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for valid values.","example":["America/New_York"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.\n","plainTextDescription":"Returns objects where the specified date or timestamp property falls within a relative date range.\nThe bounds are calculated relative to query execution time and rounded to midnight in the specified timezone.","example":[{"field":"numberOfSeats","timeZoneId":"America/New_York"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"},"type":{"type":"object","object":{"properties":{"streamRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the stream. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry stream.","plainTextDescription":"An object type datasource backed by a Foundry stream.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"lt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"}}}},"doesNotIntersectBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"}}}},"relativeDateRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeQuery"}}}},"wildcard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"}}}},"withinDistanceOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"}}}},"withinBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"}}}},"not":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"}}}},"intersectsBoundingBox":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"}}}},"containsAllTermsInOrderPrefixLastTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"}}}},"gte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"}}}},"containsAllTermsInOrder":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"}}}},"withinPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"}}}},"intersectsPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"}}}},"lte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrQueryV2"}}}},"in":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InQuery"}}}},"doesNotIntersectPolygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"}}}},"eq":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EqualsQueryV2"}}}},"containsAllTerms":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"}}}},"gt":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"}}}},"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsQueryV2"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"}}}},"isNull":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"}}}},"containsAnyTerm":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"}}}},"interval":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"}}}},"geoShapeV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"}}}},"startsWith":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Property"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"baseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyPropertyId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"},"type":{"type":"object","object":{"properties":{"minimumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maximumValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappings":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappings"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceToObjectTypeMappingsV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMappingsV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. An `interfaceToObjectTypeMappings` field is \noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\n\nThe `interfaceToObjectTypeMappings` field contains mappings from `SharedPropertyTypeApiName`s on the interface(s) to \n`PropertyApiName` for properties on the object(s).\n\nThe `interfaceToObjectTypeMappingsV2` field contains mappings from `InterfacePropertyApiName`s on the\ninterface(s) to `InterfacePropertyTypeImplementation` for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. An interfaceToObjectTypeMappings field is\noptionally returned if the type scope of the returned object set includes any interfaces. The \"type scope\"\nof an object set refers to whether objects contain all their properties (object-type type scope) or just the\nproperties that implement interface properties (interface type scope). There can be multiple type scopes in a\nsingle object set- some objects may have all their properties and some may only have interface properties.\nThe interfaceToObjectTypeMappings field contains mappings from SharedPropertyTypeApiNames on the interface(s) to\nPropertyApiName for properties on the object(s).\nThe interfaceToObjectTypeMappingsV2 field contains mappings from InterfacePropertyApiNames on the\ninterface(s) to InterfacePropertyTypeImplementation for properties on the object(s). This therefore includes\nimplementations of both properties backed by SharedPropertyTypes as well as properties defined on the interface.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinDistanceOfQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CenterPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` \nmust be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the distance provided of the center point.\nAllows you to specify a property to query on by a variety of means. Either field or propertyIdentifier\nmust be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the struct parameter field.\n","plainTextDescription":"The unique identifier of the struct parameter field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds least of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds least of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"stringFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"}}}},"localizedFormat":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequests"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSubscribeRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.\n","plainTextDescription":"The list of link subscriptions that should be established. A client can stop subscribing to links\nby removing the request from subsequent LinkTypeSubscribeRequests.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where at least one query is satisfied. An empty list matches no action types.","plainTextDescription":"Returns action types where at least one query is satisfied. An empty list matches no action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentMetadataResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"single":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}},"multiple":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The attachment metadata response","plainTextDescription":"The attachment metadata response","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"},"type":{"type":"object","object":{"properties":{"restrictedViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the restricted view.\nProperties whose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry restricted view.\n","plainTextDescription":"An object type datasource backed by a Foundry restricted view.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}},"filterLinkTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}}}},"safety":"SAFE","documentation":{"description":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.\n","plainTextDescription":"If provided, only return outgoing link types with RIDs in this list.\nIf omitted, all outgoing link types for each requested object type are returned.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DirectSourceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a direct-write source backing an object type.\n","plainTextDescription":"The RID of a direct-write source backing an object type.","example":["ri.ontology.main.direct-source.6e1b3641-2d96-4e7c-9c0f-73f7d1f3a16f"]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the InterfacePropertyType.","plainTextDescription":"A short text that describes the InterfacePropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with additional fields to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesCumulativeAggregate"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.\n","plainTextDescription":"The cumulative aggregate is calculated progressively for each point in the input time series,\nconsidering all preceding points up to and including the current point.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"\n","plainTextDescription":"Format numbers with custom units not supported by standard formatting.\nUse this for domain-specific units like \"requests/sec\", \"widgets\", etc.\nExample: 1500 with unit \"widgets\" displays as \"1,500 widgets\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}},"safety":"UNSAFE","documentation":{"description":"The conjunctive set of markings required to access the property value. \nAll markings from a conjunctive set must be met for access.\n","plainTextDescription":"The conjunctive set of markings required to access the property value.\nAll markings from a conjunctive set must be met for access.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Performs both apply reducers and extract main value to return the reduced main value.","plainTextDescription":"Performs both apply reducers and extract main value to return the reduced main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"},"type":{"type":"object","object":{"properties":{"memberTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"},"type":{"type":"object","object":{"properties":{"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the main value of a struct as configured in the ontology.","plainTextDescription":"Returns the main value of a struct as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"},"type":{"type":"enum","enum":{"values":["PERCENTAGE","PER_MILLE","BASIS_POINTS"]}},"safety":"SAFE","documentation":{"description":"Ratio format options for displaying proportional values:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix\n","plainTextDescription":"Ratio format options for displaying proportional values:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"\n","plainTextDescription":"Filter edits to only those that occurred after this timestamp (inclusive).\nISO 8601 format. Example: \"2024-01-01T00:00:00Z\"","example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"\n","plainTextDescription":"Filter edits to only those that occurred before this timestamp (inclusive).\nISO 8601 format. Example: \"2024-12-31T23:59:59Z\"","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"},"type":{"type":"object","object":{"properties":{"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\n`List object types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the\nList object types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesV2Response"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponse"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TitlePropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the title property of an object type which is present on all object types.","plainTextDescription":"Specifies the title property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the sum of values for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"},"type":{"type":"object","object":{"properties":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via the field of a local struct property.","plainTextDescription":"An implementation of an interface property via the field of a local struct property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSet"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"},"type":{"type":"enum","enum":{"values":["VALIDATE_ONLY","VALIDATE_AND_EXECUTE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `VALIDATE_AND_EXECUTE`.","plainTextDescription":"If not specified, defaults to VALIDATE_AND_EXECUTE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The current evaluation time itself. Carries no fields.","plainTextDescription":"The current evaluation time itself. Carries no fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"},"type":{"type":"object","object":{"properties":{"objects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormat"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Predefined localized formatting options.","plainTextDescription":"Predefined localized formatting options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value.","plainTextDescription":"Returns objects where the specified field is greater than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdate"},"type":{"type":"object","object":{"properties":{"selectedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedSide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"}}},"safety":"UNSAFE","documentation":{"example":[]}},"state":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkState"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single link change between two objects.","plainTextDescription":"Represents a single link change between two objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series sync.","plainTextDescription":"The RID identifying a time series sync.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"}}}},"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"}}}},"editOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditOnlyPropertyMapping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).\n","plainTextDescription":"Describes how a single object type property is bound to its backing tabular datasource. A property may be backed\nby a single column, by a struct (with nested field mappings), or be edit-only (no backing column even though it\nis permissioned to the tabular datasource).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationPrecision"},"type":{"type":"enum","enum":{"values":["DAYS","HOURS","MINUTES","SECONDS","AUTO"]}},"safety":"SAFE","documentation":{"description":"Specifies the maximum precision to apply when formatting a duration.","plainTextDescription":"Specifies the maximum precision to apply when formatting a duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `oneOf` | The struct parameter field has a manually predefined set of options. |\n| `range` | The struct parameter field value must be within the defined range. |\n| `stringLength` | The struct parameter field value must have a length within the defined range. |\n| `stringRegexMatch` | The struct parameter field value must match a predefined regular expression. |\n| `objectQueryResult` | The struct parameter field value must be the primary key of an object found within an object set. |\n","plainTextDescription":"A constraint that an action struct parameter field value must satisfy in order to be considered valid.\nConstraints can be configured on fields of struct parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| oneOf | The struct parameter field has a manually predefined set of options. |\n| range | The struct parameter field value must be within the defined range. |\n| stringLength | The struct parameter field value must have a length within the defined range. |\n| stringRegexMatch | The struct parameter field value must match a predefined regular expression. |\n| objectQueryResult | The struct parameter field value must be the primary key of an object found within an object set. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"},"type":{"type":"object","object":{"properties":{"gt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lt":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must fall within the specified date or timestamp range.","plainTextDescription":"The parameter value must fall within the specified date or timestamp range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceToObjectTypeMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an implementation of an interface (the mapping of interface property to local property).","plainTextDescription":"Represents an implementation of an interface (the mapping of interface property to local property).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructTypeMainValue"},"type":{"type":"object","object":{"properties":{"mainValueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The fields which comprise the main value of the struct.","plainTextDescription":"The fields which comprise the main value of the struct.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must have a length within the defined range.\n*This range is always inclusive.*\n","plainTextDescription":"The parameter value must have a length within the defined range.\nThis range is always inclusive.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\n\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all distinct values of a property up to the specified limit. The maximum supported limit is 100.\nNOTE: A separate cardinality / exactCardinality aggregation should be used to determine the total count of\nvalues, to account for a possible truncation of the returned set.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"},"type":{"type":"object","object":{"properties":{"linkId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}}}},"safety":"SAFE","documentation":{"description":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID. \nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.\n","plainTextDescription":"By default all UniqueIdentifier Logic Rule arguments will generate different UUID.\nIf the linkId is present all Logic Rules with the same linkId will all have the same uuid generated as the value.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Represents a unique identifier argument in a logic rule.","plainTextDescription":"Represents a unique identifier argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"}}}},"regex":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayConstraint"}}}},"length":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangesConstraint"}}}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"}}}},"uuid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UuidConstraint"}}}},"enum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeUnit"},"type":{"type":"enum","enum":{"values":["SECOND","MINUTE","HOUR","DAY","WEEK"]}},"safety":"SAFE","documentation":{"description":"Time unit for relative datetime offsets.","plainTextDescription":"Time unit for relative datetime offsets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PhraseQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains the provided value as a substring.","plainTextDescription":"Returns objects where the specified field contains the provided value as a substring.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an approximate number of distinct values for the provided field.","plainTextDescription":"Computes an approximate number of distinct values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property type that can be shared across object types.","plainTextDescription":"A property type that can be shared across object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"VersionedQueryTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'\n","plainTextDescription":"The name of the Query in the API and an optional version identifier separated by a colon.\nIf the API name contains a colon, then a version identifier of either \"latest\" or a semantic version must\nbe included.\nIf the API does not contain a colon, then either the version identifier must be excluded or a version\nidentifier of a semantic version must be included.\nExamples: 'myGroup:myFunction:latest', 'myGroup:myFunction:1.0.0', 'myFunction', 'myFunction:2.0.0'","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the primary key of an object found within an object set.\n","plainTextDescription":"The parameter value must be the primary key of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"},"type":{"type":"object","object":{"properties":{"startTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"endTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time range for a time series query.\n","plainTextDescription":"A relative time range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkSubscriptionObjectLocator"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.\n","plainTextDescription":"Identifies an object by its object type and primary key. Used in link subscription\nrequests and responses to identify objects on either side of a link.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which contain a logic rule of the given type.","plainTextDescription":"Returns action types which contain a logic rule of the given type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetOutgoingLinkTypesByObjectTypeRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A user-specified alias for an aggregation metric name.","plainTextDescription":"A user-specified alias for an aggregation metric name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"},"type":{"type":"object","object":{"properties":{"entityType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object type or interface type API name.\n","plainTextDescription":"An object type or interface type API name.","example":[]}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts an object set to a specified object type or interface type API name. Any object whose object type does \nnot match the object type provided or implement the interface type provided will be dropped from the resulting \nobject set.\n","plainTextDescription":"Casts an object set to a specified object type or interface type API name. Any object whose object type does\nnot match the object type provided or implement the interface type provided will be dropped from the resulting\nobject set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on \nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRange"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionRequest"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The request to encrypt a plaintext value into a CipherText value.\n","plainTextDescription":"The request to encrypt a plaintext value into a CipherText value.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceRid"}}},"safety":"SAFE","documentation":{"example":[]}},"definition":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The `definition` carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.\n","plainTextDescription":"A datasource that supplies property values for an object type. Each object type can have one or more\ndatasources; together they back all of the object type's properties. The definition carries the RID of the\nbacking Foundry resource (for example, the dataset RID for a dataset-backed object type), enabling callers to\nnavigate from an object type to its backing data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"},"type":{"type":"object","object":{"properties":{"conjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"disjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerConjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerConjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"containerDisjunctive":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"All marking requirements applicable to a property value.","plainTextDescription":"All marking requirements applicable to a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"},"type":{"type":"object","object":{"properties":{"ratioType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRatioType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as a ratio with different scaling factors and suffixes:\n- PERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\n- PER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\n- BASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")\n","plainTextDescription":"Display the value as a ratio with different scaling factors and suffixes:\n\nPERCENTAGE: Multiply by 100 and add \"%\" suffix (0.15 → \"15%\")\nPER_MILLE: Multiply by 1000 and add \"‰\" suffix (0.015 → \"15‰\")\nBASIS_POINTS: Multiply by 10000 and add \"bps\" suffix (0.0015 → \"15bps\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceLogicRule"}}}},"createOrModifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkLogicRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"}}}},"batchedFunction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"}}}},"createOrModifyObjectV2":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"}}}},"deleteInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceLinkLogicRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"}}}},"function":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}}},"createInterfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLinkLogicRule"}}}},"createInterface":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioLogicRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A detailed operation for an Action","plainTextDescription":"A detailed operation for an Action","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have a notification.","plainTextDescription":"Returns action types based on whether they have a notification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in the following format.\n\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| [Attachment](/docs/foundry/api/v2/ontologies-v2-resources/attachment-properties/attachment-property-basics/) | JSON encoded `AttachmentProperty` object | `{\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"}` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` | \n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| Float | number | `3.14159265` |\n| GeoPoint | geojson | `{\"type\":\"Point\",\"coordinates\":[102.0,0.5]}` |\n| GeoShape | geojson | `{\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| [MediaReference](/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}}` |\n| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{\"value\": 10, \"propertySecurityIndex\" : 5}` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n| [Timeseries](/docs/foundry/api/v2/ontologies-v2-resources/time-series-properties/time-series-property-basics/) | JSON encoded `TimeseriesProperty` object or seriesId string | `{\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"}` or `{\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"}` or `\"wellPressureSeriesId\"`| |\n| Vector | array | `[0.1, 0.3, 0.02, 0.05 , 0.8, 0.4]` |\n\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.\n","plainTextDescription":"Represents the value of a property in the following format.\n| Type | JSON encoding | Example |\n|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | JSON encoded AttachmentProperty object | {\"rid\":\"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"} |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| Float | number | 3.14159265 |\n| GeoPoint | geojson | {\"type\":\"Point\",\"coordinates\":[102.0,0.5]} |\n| GeoShape | geojson | {\"type\":\"LineString\",\"coordinates\":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]} |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| MediaReference| JSON encoded MediaReference object | {\"mimeType\":\"application/pdf\",\"reference\":{\"type\":\"mediaSetViewItem\",\"mediaSetViewItem\":{\"mediaSetRid\":\"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642\",\"mediaSetViewRid\":\"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b\",\"mediaItemRid\":\"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225\"}}} |\n| Secured Property Value | JSON encoded SecuredPropertyValue object | {\"value\": 10, \"propertySecurityIndex\" : 5} |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object of struct field API name -> value | {\"firstName\": \"Alex\", \"lastName\": \"Karp\"} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |\n| Timeseries | JSON encoded TimeseriesProperty object or seriesId string | {\"seriesId\": \"wellPressureSeriesId\", \"syncRid\": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df\"} or {\"templateRid\": \"ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9\", \"templateVersion\": \"0.0.0\"} or \"wellPressureSeriesId\"| |\n| Vector | array | [0.1, 0.3, 0.02, 0.05 , 0.8, 0.4] |\nNote that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"aggregate":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"searchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"}}}},"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStaticType"}}}},"intersect":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetIntersectionType"}}}},"withProperties":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"}}}},"interfaceLinkSearchAround":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"}}}},"nearestNeighbors":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUnionType"}}}},"asType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsTypeType"}}}},"methodInput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"}}}},"filter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"}}}},"interfaceBase":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"}}}},"asBaseObjectTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"}}}},"base":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the definition of an `ObjectSet` in the `Ontology`.","plainTextDescription":"Represents the definition of an ObjectSet in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"},"type":{"type":"object","object":{"properties":{"errors":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Arg"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectEdit"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"}}}},"removeLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkEdit"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLinkEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LengthConstraint"},"type":{"type":"object","object":{"properties":{"minimumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumLength":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an interface property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"applyReducersAndExtractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersAndExtractMainValueLoadLevel"}}}},"applyReducers":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"}}}},"extractMainValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractMainValueLoadLevel"}}}},"noLoadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The load level of the property:\n- APPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\n- EXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\n- APPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\n- NO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.\n","plainTextDescription":"The load level of the property:\n\nAPPLY_REDUCERS: Returns a single value of an array as configured in the ontology.\nEXTRACT_MAIN_VALUE: Returns the main value of a struct as configured in the ontology.\nAPPLY_REDUCERS_AND_EXTRACT_MAIN_VALUE: Performs both to return the reduced main value.\nNO_LOAD_LEVEL: Returns the property as-is, without applying reducers or extracting a struct main value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTime"},"type":{"type":"object","object":{"properties":{"when":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.\n","plainTextDescription":"A relative time, such as \"3 days before\" or \"2 hours after\" the current moment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object parameter property argument in a logic rule.","plainTextDescription":"Represents an object parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneUser"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The user's local timezone.","plainTextDescription":"The user's local timezone.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the interface type with the given rid.","plainTextDescription":"Returns action types which edit the interface type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the bounding box provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.\n","plainTextDescription":"The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the link type with the given rid.","plainTextDescription":"Returns action types which edit the link type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"qos":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QosError"}}}},"success":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionError"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"},"type":{"type":"enum","enum":{"values":["EXPERIMENTAL","ACTIVE","DEPRECATED","EXAMPLE"]}},"safety":"SAFE","documentation":{"description":"Filter action types by status.","plainTextDescription":"Filter action types by status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Number of points in each window.","plainTextDescription":"Number of points in each window.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of a column in a tabular datasource.","plainTextDescription":"The name of a column in a tabular datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Affix"},"type":{"type":"object","object":{"properties":{"prefix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"postfix":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"An allowed configured value for a parameter within an action.","plainTextDescription":"An allowed configured value for a parameter within an action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.\n","plainTextDescription":"A possible value for the parameter. This is defined in the Ontology Manager by Actions admins.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DecryptionResult"},"type":{"type":"object","object":{"properties":{"plaintext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}}}}},"safety":"DO_NOT_LOG","documentation":{"description":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText decryption. If successful, the plaintext decrypted value will be returned. Otherwise, an error will be thrown.","example":[{"plaintext":"Jane Doe"}]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value.","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Polygon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"Polygon"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatBasisPoints"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"\n","plainTextDescription":"Display the value as basis points. Multiplies by 10,000 and appends \"bps\" suffix.\nUsed in finance where 1 basis point = 0.01%.\nExample: 0.0025 displays as \"25 bps\", 0.01 displays as \"100 bps\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"},"type":{"type":"object","object":{"properties":{"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the Geotime series.\n","plainTextDescription":"The set of properties that are bound to the Geotime series.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.\n","plainTextDescription":"An object type datasource backed by a Geotime series integration, providing values for Geotime series reference\nproperties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a static argument in a logic rule.","plainTextDescription":"Represents a static argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DataValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Attachment | string | `\"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\"` |\n| Boolean | boolean | `true` |\n| Byte | number | `31` |\n| CipherText | string | `\"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\"` |\n| Date | ISO 8601 extended local date string | `\"2021-05-01\"` |\n| Decimal | string | `\"2.718281828\"` |\n| Double | number | `3.14159265` |\n| EntrySet | array of JSON objects | `[{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}]` |\n| Float | number | `3.14159265` |\n| Integer | number | `238940` |\n| Long | string | `\"58319870951433\"` |\n| Marking | string | `\"MU\"` |\n| Null | null | `null` |\n| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z` |\n| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `\"EMP1234\"` |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| `{\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"}` |\n| Ontology Object Type Reference | string of the object type's api name | `\"Employee\"` |\n| Scenario Reference | string of the scenario RID | `\"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\"` |\n| Set | array | `[\"alpha\", \"bravo\", \"charlie\"]` |\n| Short | number | `8739` |\n| String | string | `\"Call me Ishmael\"` |\n| Struct | JSON object | `{\"name\": \"John Doe\", \"age\": 42}` |\n| TwoDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]}` |\n| ThreeDimensionalAggregation | JSON object | `{\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]}` |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `\"2021-01-04T05:00:00Z\"` |\n","plainTextDescription":"Represents the value of data in the following format. Note that these values can be nested, for example an array of structs.\n| Type | JSON encoding | Example |\n|-------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Array | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Attachment | string | \"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e\" |\n| Boolean | boolean | true |\n| Byte | number | 31 |\n| CipherText | string | \"CIPHER::ri.bellaso.main.cipher-channel.e414ab9e-b606-499a-a0e1-844fa296ba7e::unzjs3VifsTxuIpf1fH1CJ7OaPBr2bzMMdozPaZJtCii8vVG60yXIEmzoOJaEl9mfFFe::CIPHER\" |\n| Date | ISO 8601 extended local date string | \"2021-05-01\" |\n| Decimal | string | \"2.718281828\" |\n| Double | number | 3.14159265 |\n| EntrySet | array of JSON objects | [{\"key\": \"EMP1234\", \"value\": \"true\"}, {\"key\": \"EMP4444\", \"value\": \"false\"}] |\n| Float | number | 3.14159265 |\n| Integer | number | 238940 |\n| Long | string | \"58319870951433\" |\n| Marking | string | \"MU\" |\n| Null | null | null |\n| Object Set | string OR the object set definition | ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z |\n| Ontology Object Reference | JSON encoding of the object's primary key | 10033123 or \"EMP1234\" |\n| Ontology Interface Object Reference | JSON encoding of the object's API name and primary key| {\"objectTypeApiName\":\"Employee\", \"primaryKeyValue\":\"EMP1234\"} |\n| Ontology Object Type Reference | string of the object type's api name | \"Employee\" |\n| Scenario Reference | string of the scenario RID | \"ri.actions..scenario.cf2a8a49-8b56-446d-ab04-a6bc7fadef48\" |\n| Set | array | [\"alpha\", \"bravo\", \"charlie\"] |\n| Short | number | 8739 |\n| String | string | \"Call me Ishmael\" |\n| Struct | JSON object | {\"name\": \"John Doe\", \"age\": 42} |\n| TwoDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"alpha\", \"value\": 100}, {\"key\": \"beta\", \"value\": 101}]} |\n| ThreeDimensionalAggregation | JSON object | {\"groups\": [{\"key\": \"NYC\", \"groups\": [{\"key\": \"Engineer\", \"value\" : 100}]}]} |\n| Timestamp | ISO 8601 extended offset date-time string in UTC zone | \"2021-01-04T05:00:00Z\" |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct list parameter field argument in a logic rule.","plainTextDescription":"Represents a struct list parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[".*fo?o*"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n - `.` matches any character.\n - `?` repeats the previous character 0 or 1 times.\n - `+` repeats the previous character 1 or more times.\n - `*` repeats the previous character 0 or more times.\n - `{}` defines the minimum and maximum number of times the preceding character can repeat. `{2}` means the\n previous character must repeat only twice, `{2,}` means the previous character must repeat at least twice,\n and `{2,4}` means the previous character must repeat between 2-4 times.\n - `|` is the OR operator.\n - `()` forms a group within an expression such that the group can be treated as a single character.\n - `[]` matches a single one of the characters contained inside the brackets, meaning [abc] matches `a`, `b` or\n `c`. Unless `-` is the first character or escaped with `\\` (in which case it is treated as a normal character),\n `-` can be used inside the bracket to create a range of characters, meaning [a-c] matches `a`, `b`, or `c`.\n If the character sequence inside the brackets begins with `^`, the set of characters is negated, meaning\n [^abc] does not match `a`, `b`, or `c`. Otherwise, `^` is treated as a normal character.\n - `\"` creates groups of string literals.\n - `\\` is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s \n and \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word \n characters respectively.\n\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the regex pattern provided. This applies to the non-analyzed\nform of text fields. Supported operators:\n\n. matches any character.\n? repeats the previous character 0 or 1 times.\n+ repeats the previous character 1 or more times.\n* repeats the previous character 0 or more times.\n{} defines the minimum and maximum number of times the preceding character can repeat. {2} means the\nprevious character must repeat only twice, {2,} means the previous character must repeat at least twice,\nand {2,4} means the previous character must repeat between 2-4 times.\n| is the OR operator.\n() forms a group within an expression such that the group can be treated as a single character.\n[] matches a single one of the characters contained inside the brackets, meaning [abc] matches a, b or\nc. Unless - is the first character or escaped with \\ (in which case it is treated as a normal character),\n- can be used inside the bracket to create a range of characters, meaning [a-c] matches a, b, or c.\nIf the character sequence inside the brackets begins with ^, the set of characters is negated, meaning\n[^abc] does not match a, b, or c. Otherwise, ^ is treated as a normal character.\n\" creates groups of string literals.\n\\ is used as an escape character. However, \\d and \\D match digit and non-digit characters respectively, \\s\nand \\S match whitespace and non whitespace characters respectively, and \\w and \\W match word and non word\ncharacters respectively.\n\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyVersion"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":["0000000d-2acf-537c-a228-3a9fe3cdc523"]}},{"locator":{"namespaceName":"Ontologies","localName":"QualifiedTimeseriesProperty"},"type":{"type":"object","object":{"properties":{"seriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"syncRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesSyncRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by multiple time series syncs.","plainTextDescription":"The representation of a time series property backed by multiple time series syncs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the minimum value for the provided field.","plainTextDescription":"Computes the minimum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of a Function, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"},"type":{"type":"object","object":{"properties":{"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length greater than or equal.","plainTextDescription":"Character length greater than or equal.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Character length less than or equal.","plainTextDescription":"Character length less than or equal.","example":[]}},"regex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","plainTextDescription":"The regular expression. Format and supported syntax match Elasticsearch regex semantics.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Message returned when the value does not match the pattern.","plainTextDescription":"Message returned when the value does not match the pattern.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.\n","plainTextDescription":"The parameter value (a string) must satisfy the configured length bounds and/or regex\npattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"propertyMarkingSummary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyMarkingSummary"}}}},"unsupportedPolicy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedPolicy"}}}},"errorComputingSecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the bounding box provided. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a struct field, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValueV2"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKeyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object types in the current page.","plainTextDescription":"The list of object types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixOnLastTokenRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.\n","plainTextDescription":"Matches intervals containing all the terms, using exact match for all but the last term, and prefix match for\nthe last term. Ordering of the terms in the query is preserved.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"},"type":{"type":"object","object":{"properties":{"datasetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Datasets","localName":"DatasetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the dataset. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry dataset.\n","plainTextDescription":"An object type datasource backed by a Foundry dataset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where at least 1 query is satisfied.","plainTextDescription":"Returns objects where at least 1 query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetStreamSubscribeRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}}}},"safety":"SAFE","documentation":{"example":[]}},"scenarioRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"referenceSet":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectLoadingResponseOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLoadingResponseOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"`branch` identifies the Foundry branch. `scenarioRid` identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, `branch` must identify that non-default base branch.\n","plainTextDescription":"branch identifies the Foundry branch. scenarioRid identifies the Ontology Scenario.\nIf a scenario is based on a non-default branch, branch must identify that non-default base branch.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the primary key value that is used as a unique identifier for an object.","plainTextDescription":"Represents the primary key value that is used as a unique identifier for an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldOfProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}},"refresh":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"}}}},"updates":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkUpdates"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Messages sent over the link type subscription WebSocket.","plainTextDescription":"Messages sent over the link type subscription WebSocket.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryOutputV2"},"type":{"type":"object","object":{"properties":{"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about the output of a query.","plainTextDescription":"Details about the output of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubtractType"},"type":{"type":"object","object":{"properties":{"objectSets":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\n\nUse collectList or collectSet which will return a list of values in that case.\n","plainTextDescription":"Gets a single value of a property. Throws if the target object set is on the MANY side of the link and could\nexplode the cardinality.\nUse collectList or collectSet which will return a list of values in that case.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A literal constraint value.","plainTextDescription":"A literal constraint value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A namespace for the type class.","plainTextDescription":"A namespace for the type class.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The value of the type class.","plainTextDescription":"The value of the type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Additional metadata that can be interpreted by user applications that interact with the Ontology\n","plainTextDescription":"Additional metadata that can be interpreted by user applications that interact with the Ontology","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregationV2"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregationV2"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregationV2"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.\n","plainTextDescription":"The name in the API of an action defined on an interface that implementing object types provide a concrete\naction type for.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"},"type":{"type":"object","object":{"properties":{"signMediaReferences":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a `token` on each `MediaReference` value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\n\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.\n","plainTextDescription":"Deprecated and ignored. Media references backed by a media set view are signed by default:\nthe response includes a token on each MediaReference value that can be used to access the\nreferenced media item directly, enabling item-level access control (the caller needs access to\nthe object whose property holds the reference, not view access on the parent media set).\nThis field no longer has any effect; setting it to true or false is ignored. Arrays of media\nreferences are not signed.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Options for signing references in the response.","plainTextDescription":"Options for signing references in the response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field.","plainTextDescription":"Computes the approximate percentile value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deleteInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteInterfaceObjectRule"}}}},"modifyInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyInterfaceObjectRule"}}}},"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectRule"}}}},"createInterfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLinkRule"}}}},"createObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"}}}},"createLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkRule"}}}},"applyScenario":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"},"type":{"type":"object","object":{"properties":{"regex":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The regular expression configured in the **Ontology Manager**.","plainTextDescription":"The regular expression configured in the Ontology Manager.","example":[]}},"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the **Ontology Manager**.\n","plainTextDescription":"The message indicating that the regular expression was not matched.\nThis is configured per parameter in the Ontology Manager.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must match a predefined regular expression.\n","plainTextDescription":"The parameter value must match a predefined regular expression.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given permission model.","plainTextDescription":"Returns action types with the given permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"},"type":{"type":"enum","enum":{"values":["START","END"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"},"type":{"type":"object","object":{"properties":{"entries":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","plainTextDescription":"Evaluated constraints of array parameters that support per-entry constraint evaluations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a parameter ID argument in a logic rule.","plainTextDescription":"Represents a parameter ID argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"implementsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements.","plainTextDescription":"A list of interfaces that this object type implements.","example":[]}},"implementsInterfaces2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interfaces that this object type implements and how it implements them.","plainTextDescription":"A list of interfaces that this object type implements and how it implements them.","example":[]}},"sharedPropertyTypeMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from shared property type API name to backing local property API name for the shared property types \npresent on this object type.\n","plainTextDescription":"A map from shared property type API name to backing local property API name for the shared property types\npresent on this object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchedFunctionLogicRule"},"type":{"type":"object","object":{"properties":{"objectSetRidInputName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RestrictedViewRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry restricted view.","plainTextDescription":"The RID of a Foundry restricted view.","example":["ri.foundry.main.restricted-view.8b2adf7c-ba8e-4d33-9bd7-46cc1c321ad4"]}},{"locator":{"namespaceName":"Ontologies","localName":"StringValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeInterfaceImplementation"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"actionTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceActionTypeConstraintApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.\n","plainTextDescription":"A map from interface action type constraint API name to the API name of the concrete action type on this\nobject type that implements it. Action types the caller is not authorized to access are omitted, so this\nmap may not cover every action type constraint declared on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionOperation"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsync","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RequestId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"Unique request id","plainTextDescription":"Unique request id","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenario"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"currentTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentTimeArgument"}}}},"staticValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticArgument"}}}},"currentUser":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"}}}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterIdArgument"}}}},"interfaceParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"}}}},"synchronousWebhookOutput":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"}}}},"objectParameterPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectParameterPropertyArgument"}}}},"uniqueIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.\n","plainTextDescription":"Represents an argument for a logic rule operation. An argument can be passed in via the action parameters, as a static value, or as some other value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrencyStyle"},"type":{"type":"enum","enum":{"values":["STANDARD","COMPACT"]}},"safety":"SAFE","documentation":{"description":"Currency rendering style options:\n- STANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\n- COMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")\n","plainTextDescription":"Currency rendering style options:\n\nSTANDARD: Full currency formatting (e.g., \"USD 1,234.56\")\nCOMPACT: Abbreviated currency formatting (e.g., \"USD 1.2K\")","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value.","plainTextDescription":"Returns objects where the specified field is less than or equal to a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where every query is satisfied.","plainTextDescription":"Returns objects where every query is satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Subtracts the right numeric value from the left numeric value.\n","plainTextDescription":"Subtracts the right numeric value from the left numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateLinkLogicRule"},"type":{"type":"object","object":{"properties":{"linkTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"targetObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the `List interface types` endpoint and check the `allPropertiesV2` field or check\nthe **Ontology Manager**.\n","plainTextDescription":"The name of the interface property type in the API in lowerCamelCase format. To find the API name for your\ninterface property type, use the List interface types endpoint and check the allPropertiesV2 field or check\nthe Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QosError"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An error indicating that the subscribe request should be attempted on a different node.\n","plainTextDescription":"An error indicating that the subscribe request should be attempted on a different node.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectUpdate"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"},"type":{"type":"object","object":{"properties":{"valueIfTrue":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is true","plainTextDescription":"Value to display if this boolean is true","example":[]}},"valueIfFalse":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Value to display if this boolean is false","plainTextDescription":"Value to display if this boolean is false","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for boolean property values.","plainTextDescription":"Formatting configuration for boolean property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which reference the object type with the given rid as an input or product.\n","plainTextDescription":"Returns action types which reference the object type with the given rid as an input or product.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceUpdate"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.\n","plainTextDescription":"The updated data value associated with an object instance's external reference. The object instance\nis uniquely identified by an object type and a primary key. Note that the value of the property\nfield returns a dereferenced value rather than the reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies an aggregation function.","plainTextDescription":"Specifies an aggregation function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String or a double number.","plainTextDescription":"An object which is either an enum String or a double number.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field contains a point within the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DoesNotIntersectPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a \nproperty to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not \nboth.\n","plainTextDescription":"Returns objects where the specified field does not intersect the polygon provided. Allows you to specify a\nproperty to query on by a variety of means. Either field or propertyIdentifier must be supplied, but not\nboth.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timestampFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryTimestampFilter"}}}},"operationIdsFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetWithPropertiesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"description":"Map of the name of the derived property to return and its definition\n","plainTextDescription":"Map of the name of the derived property to return and its definition","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet which returns objects with additional derived properties.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which returns objects with additional derived properties.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"envelope":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}}},"geoJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.\n","plainTextDescription":"Geometry specification for a GeoShapeV2Query. Supports bounding box envelopes and arbitrary GeoJSON geometries.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetBaseType"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name of the object type.","plainTextDescription":"The API name of the object type.","example":["exampleAircraft"]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Ontology"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQueryText"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.\n","plainTextDescription":"Automatically embed the text in a vector using the embedding model configured for the given propertyIdentifier.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID identifying a time series codex template that resolves to a derived series.","plainTextDescription":"The RID identifying a time series codex template that resolves to a derived series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyReducersLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns a single value of an array as configured in the ontology.","plainTextDescription":"Returns a single value of an array as configured in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Calculates absolute value of a numeric value.\n","plainTextDescription":"Calculates absolute value of a numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which edit the object type with the given rid.","plainTextDescription":"Returns action types which edit the object type with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldSelector"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"},"type":{"type":"object","object":{"properties":{"left":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"right":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides the left numeric value by the right numeric value.\n","plainTextDescription":"Divides the left numeric value by the right numeric value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter expects an array of values and the size of the array must fall within the defined range.\n","plainTextDescription":"The parameter expects an array of values and the size of the array must fall within the defined range.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"},"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Setting fuzzy to `true` allows approximate matching in search queries that support it.","plainTextDescription":"Setting fuzzy to true allows approximate matching in search queries that support it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"},"type":{"type":"object","object":{"properties":{"values":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".\n","plainTextDescription":"Map integer values to custom human-readable strings.\nExample: {1: \"First\", 2: \"Second\", 3: \"Third\"} would display 2 as \"Second\".","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"count":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"},"type":{"type":"enum","enum":{"values":["ACTIVE","DEPRECATED"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given rid.","plainTextDescription":"Returns action types with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"UNSAFE","documentation":{"description":"TBD","plainTextDescription":"TBD","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action parameter, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"},"type":{"type":"enum","enum":{"values":["CEIL","FLOOR","ROUND_CLOSEST"]}},"safety":"SAFE","documentation":{"description":"Number rounding behavior:\n- CEIL: Always round up (3.1 becomes 4)\n- FLOOR: Always round down (3.9 becomes 3)\n- ROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)\n","plainTextDescription":"Number rounding behavior:\n\nCEIL: Always round up (3.1 becomes 4)\nFLOOR: Always round down (3.9 becomes 3)\nROUND_CLOSEST: Round to nearest (3.4 becomes 3, 3.6 becomes 4)","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPeriodicAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}},"safety":"SAFE","documentation":{"example":[]}},"alignmentTimestamp":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}}}},"safety":"SAFE","documentation":{"description":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\n\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\n\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM, \neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.\n","plainTextDescription":"The timestamp used to align the result, such that ticks in the result time series will lie at integer\nmultiples of the window duration from the alignment timestamp.\nDefault is the first epoch timestamp (January 1, 1970, 00:00:00 UTC) so that all aggregated points have\ntimestamps at midnight UTC at the start of each window duration.\nFor example, for a weekly aggregate with alignment timestamp 5 January, 8:33PM,\neach aggregated timestamp will lie on the 7 day intervals at 8:33PM starting at 5 January.","example":[]}},"windowType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesWindowType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Aggregates values over discrete, periodic windows for a given time series.\n\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\n\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.\n","plainTextDescription":"Aggregates values over discrete, periodic windows for a given time series.\nA periodic window divides the time series into windows of fixed durations.\nFor each window, an aggregate function is applied to the points within that window. The result is a time series\nwith values representing the aggregate for each window. Windows with no data points are not included\nin the output.\nPeriodic aggregation is useful for downsampling a continuous stream of data to larger granularities such as\nhourly, daily, monthly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.\n","plainTextDescription":"Fuzzy search is turned off. Matches generated by modifying one or more characters of the search query are\nnot returned.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter must be omitted or empty.","plainTextDescription":"The parameter must be omitted or empty.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The response when loading entries from a geotemporal series reference property.\n\nEach entry in `data` is a map of property names to values containing the fields requested via\n`additionalProperties` in the corresponding `LoadGeotemporalSeriesRequest`. If `nextPageToken` is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.\n","plainTextDescription":"The response when loading entries from a geotemporal series reference property.\nEach entry in data is a map of property names to values containing the fields requested via\nadditionalProperties in the corresponding LoadGeotemporalSeriesRequest. If nextPageToken is present,\nadditional entries are available and can be retrieved by passing the token in a subsequent request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names that have been modified within the scenario.","plainTextDescription":"The list of link type API names that have been modified within the scenario.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The link types that have been modified within a scenario.\n","plainTextDescription":"The link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditTypeFilter"},"type":{"type":"enum","enum":{"values":["create","modify","delete"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is in development.","plainTextDescription":"This status indicates that the PropertyType is in development.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"},"type":{"type":"enum","enum":{"values":["RUNNING_SUBMISSION_CHECKS","EXECUTING_WRITE_BACK_WEBHOOK","COMPUTING_ONTOLOGY_EDITS","COMPUTING_FUNCTION","WRITING_ONTOLOGY_EDITS","EXECUTING_SIDE_EFFECT_WEBHOOK","SENDING_NOTIFICATIONS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"output":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a query type in the Ontology.","plainTextDescription":"Represents a query type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to \nspecify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, \nbut not both.\n","plainTextDescription":"Returns objects where the specified field contains a point within the bounding box provided. Allows you to\nspecify a property to query on by a variety of means. Either field or propertyIdentifier must be supplied,\nbut not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryRequest"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"filters":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryFilter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sortOrder":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"}}}}},"safety":"SAFE","documentation":{"example":[]}},"includeAllPreviousProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of edits to return per page. Defaults to 100.","plainTextDescription":"The maximum number of edits to return per page. Defaults to 100.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request object for querying object type edits history, containing both filters and pagination parameters\n\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.\n","plainTextDescription":"Request object for querying object type edits history, containing both filters and pagination parameters\nIf objectPrimaryKey property is set, the method will return edits history for the particular object.\nOtherwise, the method will return edits history for all objects of this object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"cause":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The subscription has been closed due to an irrecoverable error during its lifecycle.\n","plainTextDescription":"The subscription has been closed due to an irrecoverable error during its lifecycle.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface link type.","plainTextDescription":"The description of the interface link type.","example":[]}},"linkedEntityApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare at least one implementation of this link.\n","plainTextDescription":"Whether each implementing object type must declare at least one implementation of this link.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.\n","plainTextDescription":"A link type constraint defined at the interface level where the implementation of the links is provided\nby the implementing object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentPropertyV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListQueryTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface property type.","plainTextDescription":"The description of the interface property type.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"requireImplementation":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.\n","plainTextDescription":"An interface property type with an additional field to indicate constraints that need to be satisfied by\nimplementing object property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceParameterPropertyArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyTypeRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface parameter property argument in a logic rule.","plainTextDescription":"Represents an interface parameter property argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedLinksResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of linked objects that have been edited within the scenario, grouped by source object.\n","plainTextDescription":"The list of linked objects that have been edited within the scenario, grouped by source object.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.\n","plainTextDescription":"The linked objects that have been edited within a scenario for a given link type, grouped by source object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the `List interface types` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface\ntype, use the List interface types endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterDatetimeValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"now":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NowDatetimeValue"}}}},"fixed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A datetime bound value.","plainTextDescription":"A datetime bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The ID identifying a transaction.","plainTextDescription":"The ID identifying a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NoLoadLevel"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via `PropertyWithLoadLevelSelector`) to opt a property out of a\n`defaultLoadLevel`.\n","plainTextDescription":"Returns the property as-is, without applying reducers or extracting a struct main value. Useful as an\nexplicit per-property load level (via PropertyWithLoadLevelSelector) to opt a property out of a\ndefaultLoadLevel.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.\n","plainTextDescription":"This status indicates that the PropertyType will not change on short notice and should thus be safe to use in\nuser facing workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFuzziness"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"auto":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"}}}},"off":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessOff"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Fuzziness setting applied to `contains` full-text string predicates in the search query. If not provided,\n`auto` is used.\n","plainTextDescription":"Fuzziness setting applied to contains full-text string predicates in the search query. If not provided,\nauto is used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an object type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesEntry"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.\n","plainTextDescription":"A single geotemporal data point. Each entry is a map from property API names to property values. Standard\nentries include \"time\" (ISO 8601 timestamp) and \"position\" (GeoPoint), and may include additional geotemporal\nseries metadata fields such as speed, heading, or altitude.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.\n","plainTextDescription":"Standard number formatting with configurable options.\nThis provides basic number formatting without any special units, scaling, or transformations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistorySortOrder"},"type":{"type":"enum","enum":{"values":["newest_first","oldest_first"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"queryTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaMetadata"},"type":{"type":"object","object":{"properties":{"path":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaItemPath"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregate"},"type":{"type":"object","object":{"properties":{"windowSize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Adds two or more numeric values.\n","plainTextDescription":"Adds two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadGeotemporalSeriesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}},"safety":"UNSAFE","documentation":{"example":[]}},"additionalProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.\n","plainTextDescription":"The additional property API names to include in each entry. The \"time\" and \"position\" properties are always\nincluded and do not need to be specified here. Use this to request additional geotemporal series metadata\nproperties such as \"speed\" or \"heading\". Properties that are not available for the underlying geotemporal\nintegration will be omitted from the response entries.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request body for loading entries from a geotemporal series reference property.\n\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as `OntologyObjectV2`.\n\nThe `range` field is required and restricts results to a specific time window. Both `startTime` and `endTime`\nare required on `range`. The `additionalProperties` field controls which additional properties appear in each\nreturned entry. Results are paginated; use `pageToken` from a previous response to retrieve additional pages.\n","plainTextDescription":"The request body for loading entries from a geotemporal series reference property.\nA geotemporal series represents time-indexed geographic observations for an object, such as the location history\nof a vehicle or aircraft. Each entry in the response is a map of property names to values, following the same\nstructure as OntologyObjectV2.\nThe range field is required and restricts results to a specific time window. Both startTime and endTime\nare required on range. The additionalProperties field controls which additional properties appear in each\nreturned entry. Results are paginated; use pageToken from a previous response to retrieve additional pages.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransaction"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedValuesMapKey"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Integer key for fixed value mapping.","plainTextDescription":"Integer key for fixed value mapping.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Query"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExecuteQueryResponse"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"By default, whenever an object is requested, all of its properties are returned, except for properties of the \nfollowing types:\n- Vector\n\nThe response can be filtered to only include certain properties using the `properties` query parameter. Note\nthat ontology object set endpoints refer to this parameter as `select`.\n\nProperties to include can be specified in one of two ways.\n\n- A comma delimited list as the value for the `properties` query parameter\n `properties={property1ApiName},{property2ApiName}`\n- Multiple `properties` query parameters.\n `properties={property1ApiName}&properties={property2ApiName}`\n\nThe primary key of the object will always be returned even if it wasn't specified in the `properties` values.\n\nUnknown properties specified in the `properties` list will result in a `PropertiesNotFound` error.\n\nTo find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**.\n","plainTextDescription":"By default, whenever an object is requested, all of its properties are returned, except for properties of the\nfollowing types:\n\nVector\n\nThe response can be filtered to only include certain properties using the properties query parameter. Note\nthat ontology object set endpoints refer to this parameter as select.\nProperties to include can be specified in one of two ways.\n\nA comma delimited list as the value for the properties query parameter\nproperties={property1ApiName},{property2ApiName}\nMultiple properties query parameters.\nproperties={property1ApiName}&properties={property2ApiName}\n\nThe primary key of the object will always be returned even if it wasn't specified in the properties values.\nUnknown properties specified in the properties list will result in a PropertiesNotFound error.\nTo find the API name for your property, use the Get object type endpoint or check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RidConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The string must be a valid RID (Resource Identifier).","plainTextDescription":"The string must be a valid RID (Resource Identifier).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BoundingBoxValue"},"type":{"type":"object","object":{"properties":{"topLeft":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bottomRight":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The top left and bottom right coordinate points that make up the bounding box.\n","plainTextDescription":"The top left and bottom right coordinate points that make up the bounding box.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is less than or equal to a value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKey"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditsHistoryOperationIdsFilter"},"type":{"type":"object","object":{"properties":{"operationIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SynchronousWebhookOutputArgument"},"type":{"type":"object","object":{"properties":{"webhookOutputParamName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the webhook output parameter.","plainTextDescription":"The name of the webhook output parameter.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a synchronous webhook output argument in a logic rule.","plainTextDescription":"Represents a synchronous webhook output argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntervalQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of \ntext fields. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the sub-rule provided. This applies to the analyzed form of\ntext fields. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GteQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property \nto query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than or equal to a value. Allows you to specify a property\nto query on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types where every query is satisfied. An empty list matches all action types.","plainTextDescription":"Returns action types where every query is satisfied. An empty list matches all action types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationObjectTypeGrouping"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across \nmultiple object types, such as when aggregating over an interface type.\n","plainTextDescription":"Divides objects into groups based on their object type. This grouping is only useful when aggregating across\nmultiple object types, such as when aggregating over an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types.\nWhen grouping by YEARS, QUARTERS, MONTHS, or WEEKS, the value must be set to 1.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"},"type":{"type":"enum","enum":{"values":["ASC","DESC"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"},"type":{"type":"object","object":{"properties":{"disjunction":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurity"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A disjunctive set of security results for a property value.\n","plainTextDescription":"A disjunctive set of security results for a property value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FixedDatetimeValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute datetime bound (ISO 8601 timestamp or date string).","plainTextDescription":"An absolute datetime bound (ISO 8601 timestamp or date string).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshLinks"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Indicates that the link types cannot be incrementally updated and must be refreshed.\n","plainTextDescription":"Indicates that the link types cannot be incrementally updated and must be refreshed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResultV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.\n","plainTextDescription":"The value of the metric. This will be a double in the case of\na numeric metric, or a date string in the case of a date metric.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeUnit"},"type":{"type":"enum","enum":{"values":["DAY","WEEK","MONTH","YEAR"]}},"safety":"SAFE","documentation":{"description":"Units for relative time calculations.","plainTextDescription":"Units for relative time calculations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"versionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeVersionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must conform to the referenced value type.","plainTextDescription":"The parameter value must conform to the referenced value type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesEntry"},"type":{"type":"object","object":{"properties":{"time":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 timestamp","plainTextDescription":"An ISO 8601 timestamp","example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"An object which is either an enum String, double number, or a geopoint.","plainTextDescription":"An object which is either an enum String, double number, or a geopoint.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A time and value pair.\n","plainTextDescription":"A time and value pair.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesPointsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesPoint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.","plainTextDescription":"Divides objects into groups according to an exact value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"deleteObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"deleteLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"add":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddPropertyExpression"}}}},"absoluteValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteValuePropertyExpression"}}}},"extract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"}}}},"selection":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"}}}},"negate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NegatePropertyExpression"}}}},"subtract":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubtractPropertyExpression"}}}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"}}}},"least":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LeastPropertyExpression"}}}},"divide":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DividePropertyExpression"}}}},"multiply":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"}}}},"greatest":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Definition of a derived property.\n","plainTextDescription":"Definition of a derived property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Duration"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.\n","plainTextDescription":"Divides objects into groups according to an interval. Note that this grouping applies only on date types.\nThe interval uses the ISO 8601 notation. For example, \"PT1H2M34S\" represents a duration of 3754 seconds.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"},"type":{"type":"object","object":{"properties":{"editedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplyPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Multiplies two or more numeric values.\n","plainTextDescription":"Multiplies two or more numeric values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object in the Ontology.","plainTextDescription":"Represents an object in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"},"type":{"type":"object","object":{"properties":{"wrappedType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique id of a geotime series (track) associated with a GTSR.","plainTextDescription":"The unique id of a geotime series (track) associated with a GTSR.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"},"type":{"type":"object","object":{"properties":{"kind":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `kind` attribute of a type class.","plainTextDescription":"Exact match predicate for the kind attribute of a type class.","example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exact match predicate for the `name` attribute of a type class.","plainTextDescription":"Exact match predicate for the name attribute of a type class.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching type classes. Matches a type class when `kind`, and `name` if provided, match the\ncorresponding attribute of the type class. If `name` is empty, only `kind` is required to match. You can\nsearch for both parameter type classes and action type type classes.\n","plainTextDescription":"A predicate for matching type classes. Matches a type class when kind, and name if provided, match the\ncorresponding attribute of the type class. If name is empty, only kind is required to match. You can\nsearch for both parameter type classes and action type type classes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type API names scoped by the object type.","plainTextDescription":"The list of link type API names scoped by the object type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.\n","plainTextDescription":"Groups link type API names by the object type they're scoped to. Link type API names are only unique within\nan object type, so this pairing is required to identify a link type unambiguously.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Attachment"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either `field` or `propertyIdentifier` must be supplied, but not both.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field equals any of the provided values. Allows you to\nspecify a property to query on by a variety of means. If an empty array is provided as the value, then the filter will match all objects\nin the object set. Either field or propertyIdentifier must be supplied, but not both.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation ranges.\n","plainTextDescription":"A union of all the types supported by query aggregation ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArrayEntryEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","plainTextDescription":"Evaluated constraints for entries of array parameters for which per-entry evaluation is supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeDuration"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"The magnitude of a relative datetime offset.","plainTextDescription":"The magnitude of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings required to access the property value.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2MultipleObjectTypesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"loadPropertySecurities":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the `propertySecurities` field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the `propertySecurities` list.\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load the securities for all properties.\nSetting this flag to true will return a list of securities in the propertySecurities field of the response.\nReturned objects will return all properties as Secured Property Values, which provide the property data\nas well an index into the propertySecurities list.\nThis feature is experimental and not yet generally available.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsMultipleObjectTypes` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsMultipleObjectTypes endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"},"type":{"type":"object","object":{"properties":{"mode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionMode"}}}}},"safety":"SAFE","documentation":{"example":[]}},"returnEdits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an ontology scenario.","plainTextDescription":"The unique resource identifier of an ontology scenario.","example":["ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"},"type":{"type":"object","object":{"properties":{"tableRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TableRid"}}},"safety":"SAFE","documentation":{"example":[]}},"branch":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyMapping":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeMappingInfo"}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.\n","plainTextDescription":"A mapping from property API name to a description of how that property is bound to the table. Properties\nwhose mapping info cannot be modeled are omitted.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry table.","plainTextDescription":"An object type datasource backed by a Foundry table.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of an object type. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your Object Type, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsRequest"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TransactionEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The request payload for staging edits to a transaction.","plainTextDescription":"The request payload for staging edits to a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Duration"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An ISO 8601 formatted duration.","plainTextDescription":"An ISO 8601 formatted duration.","example":["PT15M"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListAttachmentsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetReferenceType"},"type":{"type":"object","object":{"properties":{"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"}}}},"datetime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeAllowedValues"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"}}}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeAllowedValues"}}}},"markdown":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkdownAllowedValues"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeAllowedValues"}}}},"mustBeEmpty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MustBeEmptyAllowedValues"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TextAllowedValues"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The allowed-values constraint configured on an action parameter.","plainTextDescription":"The allowed-values constraint configured on an action parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApproximatePercentileAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"approximatePercentile":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the approximate percentile value for the provided field. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"},"type":{"type":"object","object":{"properties":{"implementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via applying reducers on the nested implementation.","plainTextDescription":"An implementation of an interface property via applying reducers on the nested implementation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"excludedItems":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"}}},"safety":"SAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItemV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"An override value to be used for a UniqueIdentifier action parameter, instead of \nthe value being automatically generated.\n","plainTextDescription":"An override value to be used for a UniqueIdentifier action parameter, instead of\nthe value being automatically generated.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderPrefixLastTerm"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided, \nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosureCause"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Reason"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Error"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.","plainTextDescription":"Divides objects into groups with the specified width.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioConflictingObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects that have a conflicting edit within the scenario.","plainTextDescription":"The list of objects that have a conflicting edit within the scenario.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The objects that have a conflicting edit within a scenario for a given object type.","plainTextDescription":"The objects that have a conflicting edit within a scenario for a given object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationRangeSubType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Affix"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"\n","plainTextDescription":"Attach arbitrary text before and/or after the formatted number.\nExample: prefix \"USD \" and postfix \" total\" displays as \"USD 1,234.56 total\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"modifyObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"}}}},"addObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddObject"}}}},"addLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AddLink"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSearchJsonQueryV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"webhookRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"WebhookRidActionTypesQueryV2"}}}},"hasActionLog":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"}}}},"actionTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiNameActionTypesQueryV2"}}}},"or":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrActionTypesQueryV2"}}}},"permissionModel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PermissionModelActionTypesQueryV2"}}}},"hasWebhook":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"}}}},"actionTypeDisplayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"}}}},"affectedLinkTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedLinkTypeRidActionTypesQueryV2"}}}},"actionTypeDescription":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"}}}},"sectionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"}}}},"parameterRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"}}}},"parameterName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterNameActionTypesQueryV2"}}}},"hasNotification":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HasNotificationActionTypesQueryV2"}}}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"}}}},"inputObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InputObjectTypeRidActionTypesQueryV2"}}}},"revertActionEnabled":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RevertActionEnabledActionTypesQueryV2"}}}},"logicRule":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleActionTypesQueryV2"}}}},"typeClasses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"}}}},"affectedInterfaceTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedInterfaceTypeRidActionTypesQueryV2"}}}},"and":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AndActionTypesQueryV2"}}}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRidActionTypesQueryV2"}}}},"affectedObjectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AffectedObjectTypeRidActionTypesQueryV2"}}}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the search query for an action type search. Supports filters for various action type features.\n","plainTextDescription":"Represents the search query for an action type search. Supports filters for various action type features.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the average value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about some property of an object.","plainTextDescription":"Details about some property of an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GtQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field is greater than a value. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRelation"},"type":{"type":"enum","enum":{"values":["BEFORE","AFTER"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluationResult"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"evaluatedConstraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldEvaluatedConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"description":"Represents whether the parameter is a required input to the action.","plainTextDescription":"Represents whether the parameter is a required input to the action.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the validity of a struct parameter's fields against the configured constraints.","plainTextDescription":"Represents the validity of a struct parameter's fields against the configured constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotQuery"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the query is not satisfied.","plainTextDescription":"Returns objects where the query is not satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Plaintext"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"DO_NOT_LOG","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.","plainTextDescription":"Divides objects into groups according to specified ranges.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"},"type":{"type":"object","object":{"properties":{"unionTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzinessAuto"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.\n","plainTextDescription":"Fuzzy search is activated, which can help discover additional results based on small differences in\nspelling, although some additional results may be less relevant.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AllTermsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains all of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"interfaceDefinedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceDefinedPropertyType"}}}},"interfaceSharedPropertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.\n","plainTextDescription":"The definition of an interface property type on an interface. An interface property can either be backed by a\nshared property type or defined on the interface directly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"toolDescription":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Optional description intended for tool use contexts, such as AI agents.","plainTextDescription":"Optional description intended for tool use contexts, such as AI agents.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExactDistinctAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes an exact number of distinct values for the provided field. May be slower than an approximate\ndistinct aggregation. Requires Object Storage V2.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRange"},"type":{"type":"object","object":{"properties":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end date.","plainTextDescription":"Exclusive end date.","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive end date.","plainTextDescription":"Inclusive end date.","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Exclusive start date.","plainTextDescription":"Exclusive start date.","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start date.","plainTextDescription":"Inclusive start date.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a date range from an inclusive start date to an exclusive end date.","plainTextDescription":"Specifies a date range from an inclusive start date to an exclusive end date.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeV2"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"pluralDisplayName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The plural display name of the object type.","plainTextDescription":"The plural display name of the object type.","example":[]}},"icon":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Icon"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"titleProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"aliases":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. `getObjectTypeV2`); it is always empty on the `listObjectTypesV2` endpoint.\n","plainTextDescription":"Alternative names (synonyms) for the object type, usable as search terms. This field is only populated on\nthe get-by-RID read paths (e.g. getObjectTypeV2); it is always empty on the listObjectTypesV2 endpoint.","example":[]}},"datasources":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasource"}}}}},"safety":"UNSAFE","documentation":{"description":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies `includeDatasources=true`. This list may be empty if the user doesn't have access to any\ndatasources.\n","plainTextDescription":"The datasources backing this object type which the user has access to see. Only populated when the request\nspecifies includeDatasources=true. This list may be empty if the user doesn't have access to any\ndatasources.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"description":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\n\nEach object type's `linkTypes` is only populated when the request specifies\n`includeLinkTypes=true`, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.\n","plainTextDescription":"The requested object types, in the order they were requested. Object types that were not found are\nomitted, so this may contain fewer entries than were requested.\nEach object type's linkTypes is only populated when the request specifies\nincludeLinkTypes=true, and is ordered by link type API name. It may also be empty if the object\ntype has no outgoing link types, or if the requesting token cannot see the object types on the\nother side of them.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectSetChanged":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"}}}},"refreshObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"}}}},"subscriptionClosed":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionClosed"}}}},"subscribeResponses":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"},"type":{"type":"object","object":{"properties":{"includesAllPreviousValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"previousProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"description":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.\n","plainTextDescription":"The property values before the modification.\nOnly includes properties that were changed.\nMaps property API names to their previous values.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Query"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"geometry":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeoShapeV2Geometry"}}},"safety":"UNSAFE","documentation":{"example":[]}},"spatialFilterMode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field satisfies the provided geometry query with the given spatial operator.\nSupports both envelope (bounding box) and GeoJSON geometries for filtering geopoint or geoshape properties.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager**\napplication.\n","plainTextDescription":"The name of the link type in the API. To find the API name for your Link Type, check the Ontology Manager\napplication.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StatusActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeStatusFilter"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with the given status.","plainTextDescription":"Returns action types with the given status.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an attachment.","plainTextDescription":"The unique resource identifier of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"},"type":{"type":"object","object":{"properties":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderingV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the `fields` array is provided, `orderType` is automatically set to `fields`.\nIf this object is omitted entirely, the ordering is unspecified.\n\nSetting `orderType` to `relevance` requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. `containsAllTerms`, `containsAnyTerm`,\n`containsAllTermsInOrder`, `containsAllTermsInOrderPrefixLastTerm`) or `nearestNeighbors`, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\n\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\n\nRelevance ordering can be expensive and should only be used when required.\n","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction, or by relevance.\nIf the fields array is provided, orderType is automatically set to fields.\nIf this object is omitted entirely, the ordering is unspecified.\nSetting orderType to relevance requests that results are sorted by decreasing relevance score.\nFor queries that include text search filters (e.g. containsAllTerms, containsAnyTerm,\ncontainsAllTermsInOrder, containsAllTermsInOrderPrefixLastTerm) or nearestNeighbors, the\nrelevance score reflects how well each object matches the query. For other queries, the ordering\nis unspecified.\nWhen paging through results ordered by relevance, ordering is not guaranteed to be consistent\nacross pages: an object may appear on multiple pages or be skipped entirely. Use a single page\nwhen result completeness is required.\nRelevance ordering can be expensive and should only be used when required.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryThreeDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"groups":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NestedQueryAggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"},"type":{"type":"object","object":{"properties":{"showFullUnits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Whether to show full or abbreviated time units.","plainTextDescription":"Whether to show full or abbreviated time units.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formats the duration as a human-readable written string.","plainTextDescription":"Formats the duration as a human-readable written string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeTimezoneStatic"},"type":{"type":"object","object":{"properties":{"zoneId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CenterPointTypes"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotemporalSeriesProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"},"type":{"type":"enum","enum":{"values":["fields","relevance"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"approximateDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximateDistinctAggregation"}}}},"min":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMinAggregation"}}}},"avg":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"}}}},"max":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"}}}},"approximatePercentile":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApproximatePercentileAggregation"}}}},"get":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetSelectedPropertyOperation"}}}},"count":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCountAggregation"}}}},"sum":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"}}}},"collectList":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"}}}},"exactDistinct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExactDistinctAggregation"}}}},"collectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectSetAggregation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property\n","plainTextDescription":"Operation on a selected property, can be an aggregation function or retrieval of a single selected property","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"},"type":{"type":"object","object":{"properties":{"defaultValidation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation metadata surfaced for a parameter.","plainTextDescription":"Validation metadata surfaced for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGrouping"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGrouping"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGrouping"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGrouping"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldPropertyMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A mapping from the backing column struct field names to a struct property's fields.\n","plainTextDescription":"A mapping from the backing column struct field names to a struct property's fields.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregationV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Computes the maximum value for the provided field.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AddObjectEdit"},"type":{"type":"object","object":{"properties":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"},"type":{"type":"object","object":{"properties":{"format":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DatetimeFormat"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Formatting configuration for date property values.","plainTextDescription":"Formatting configuration for date property values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDisplayNameActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a display name matching the given string predicate.","plainTextDescription":"Returns action types with a display name matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"},"type":{"type":"enum","enum":{"values":["SUM","MEAN","STANDARD_DEVIATION","MAX","MIN","PERCENT_CHANGE","DIFFERENCE","PRODUCT","COUNT","FIRST","LAST"]}},"safety":"SAFE","documentation":{"description":"The aggregation function to use for aggregating time series data.\n","plainTextDescription":"The aggregation function to use for aggregating time series data.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"ranges":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to specified ranges.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to specified ranges.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"},"type":{"type":"object","object":{"properties":{"edits":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdit"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"addedObjectCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"modifiedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedObjectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"addedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"deletedLinksCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StructFieldName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"legacyObjectTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LegacyObjectTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the object type.","plainTextDescription":"The description of the object type.","example":[]}},"visibility":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeVisibility"}}}}},"safety":"SAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","plainTextDescription":"The primary key of the object. This is a list of properties that can be used to uniquely identify the object.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Property"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the object type.","plainTextDescription":"A map of the properties of the object type.","example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an object type in the Ontology.","plainTextDescription":"Represents an object type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FuzzyRule"},"type":{"type":"object","object":{"properties":{"term":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The term to match.","plainTextDescription":"The term to match.","example":[]}},"fuzziness":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.\n","plainTextDescription":"Maximum edit distance allowed for matching. Valid values are 0, 1, or 2. Defaults to 2.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.\n","plainTextDescription":"Matches intervals containing terms that are similar to the provided term, within an edit distance\ndefined by fuzziness. An edit is a single character change needed to make a term match, including\ncharacter insertion, deletion, substitution, or transposition of two adjacent characters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier (ID) for an object type. This can be viewed in [Ontology Manager](/docs/foundry/ontology-manager/overview/).","plainTextDescription":"The unique identifier (ID) for an object type. This can be viewed in Ontology Manager.","example":["example-aircraft"]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOntologyScenarioResponse"},"type":{"type":"object","object":{"properties":{"scenarioRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyScenarioRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The response payload for creating an ontology scenario.","plainTextDescription":"The response payload for creating an ontology scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesRollingAggregateWindow"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"}}}},"pointsCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RollingAggregateWindowPoints"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\n\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.\n","plainTextDescription":"A rolling window is a moving subset of data points that ends at the current timestamp (inclusive)\nand spans a specified duration (window size). As new data points are added, old points fall out of the\nwindow if they are outside the specified duration.\nRolling windows are commonly used for smoothing data, detecting trends, and reducing noise\nin time series analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"},"type":{"type":"object","object":{"properties":{"typeId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to a type that is defined in the `typeReferences` map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.\n","plainTextDescription":"A reference to a type that is defined in the typeReferences map of the enclosing Query.\nThis enables support for recursive type definitions where a type may reference itself.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"},"type":{"type":"object","object":{"properties":{"uniqueIdentifierLinkIdValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierValue"}}}}},"safety":"SAFE","documentation":{"example":[]}},"actionExecutionTime":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"},"type":{"type":"object","object":{"properties":{"scaleType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"}}},"safety":"SAFE","documentation":{"example":[]}},"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n- THOUSANDS: 1500 displays as \"1.5K\"\n- MILLIONS: 2500000 displays as \"2.5M\"\n- BILLIONS: 3200000000 displays as \"3.2B\"\n","plainTextDescription":"Scale the numeric value by dividing by the specified factor and append an appropriate suffix.\n\nTHOUSANDS: 1500 displays as \"1.5K\"\nMILLIONS: 2500000 displays as \"2.5M\"\nBILLIONS: 3200000000 displays as \"3.2B\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The API names of the object type properties to include in the response.\n","plainTextDescription":"The API names of the object type properties to include in the response.","example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `__rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the __rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings representing the same sequence of characters as the given string.","plainTextDescription":"Matches strings representing the same sequence of characters as the given string.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"},"type":{"type":"enum","enum":{"values":["actionTypeDisplayName"]}},"safety":"SAFE","documentation":{"description":"Specifies the field to sort action types by.","plainTextDescription":"Specifies the field to sort action types by.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentAllowedValues"},"type":{"type":"object","object":{"properties":{"maxSizeBytes":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","plainTextDescription":"The parameter value (an attachment rid) must reference an attachment within the configured size limit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property filter. For instance, false is the FilterValue in\n`properties.{propertyApiName}.isNull=false`.\n","plainTextDescription":"Represents the value of a property filter. For instance, false is the FilterValue in\nproperties.{propertyApiName}.isNull=false.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkState"},"type":{"type":"enum","enum":{"values":["ADDED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.\n","plainTextDescription":"Represents the state of a link change. ADDED indicates the link was created. REMOVED indicates\nthe link was deleted. Updates are represented as a REMOVED followed by an ADDED LinkState in a\nsingle LinkUpdates message.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionWithOverridesRequest"},"type":{"type":"object","object":{"properties":{"request":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"overrides":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionOverrides"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesRequest"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"select":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"selectV2":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"description":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.\n","plainTextDescription":"The identifiers of the properties to include in the response. Only selectV2 or select should be populated,\nbut not both.","example":[]}},"defaultLoadLevel":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadOntologyDefinedDerivedProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (`select`/`selectV2`) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\n\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"A flag to load ontology-defined derived properties (OTDPs) in the response. Defaults to true.\nOnly applies when no explicit property selection (select/selectV2) is provided; when specific\nproperties are selected, this flag has no effect and the selected properties are always returned.\nThis flag does not affect interface properties that are implemented by an OTDP on an\nobject type; those are always returned regardless of this flag.\nThis feature is experimental and not yet generally available.","example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"excludeRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to exclude the retrieval of the `$rid` property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.\n","plainTextDescription":"A flag to exclude the retrieval of the $rid property.\nSetting this to true may improve performance of this endpoint for object types in OSV2.","example":[]}},"snapshot":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.\n","plainTextDescription":"A flag to use snapshot consistency when paging.\nSetting this to true will give you a consistent view from before you start paging through the results, ensuring you do not get duplicate or missing items.\nSetting this to false will let new results enter as you page, but you may encounter duplicate or missing items.\nThis defaults to false if not specified, which means you will always get the latest results.","example":[]}},"referenceSigningOptions":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReferenceSigningOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API POST body when loading an `ObjectSet`. Used on the `/loadObjectsOrInterfaces` endpoint only.\n","plainTextDescription":"Represents the API POST body when loading an ObjectSet. Used on the /loadObjectsOrInterfaces endpoint only.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingInterfaceLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface link types in the current page.","plainTextDescription":"The list of interface link types in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SpatialFilterMode"},"type":{"type":"enum","enum":{"values":["INTERSECTS","DISJOINT","WITHIN","CONTAINS"]}},"safety":"SAFE","documentation":{"description":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.\n","plainTextDescription":"The spatial relation operator for a GeoShapeV2Query. INTERSECTS matches objects that intersect the provided\ngeometry, DISJOINT matches objects that do not intersect the provided geometry, WITHIN matches objects that\nlie within the provided geometry, and CONTAINS matches objects that contain the provided geometry.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeoJsonString"},"type":{"type":"object","object":{"properties":{"geoJson":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.\n","plainTextDescription":"A GeoJSON geometry string. Supported geometry types include Point, MultiPoint, LineString,\nMultiLineString, Polygon, MultiPolygon, and GeometryCollection.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A GeoJSON geometry specification.","plainTextDescription":"A GeoJSON geometry specification.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"links":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"includeComputeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IncludeComputeUsage"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The version of the given Function, written `..-`, where `-` is optional.\nExamples: `1.2.3`, `1.2.3-rc1`.\n","plainTextDescription":"The version of the given Function, written ..-, where - is optional.\nExamples: 1.2.3, 1.2.3-rc1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RefreshObjectSet"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.\n","plainTextDescription":"The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDateRangeBound"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"relativePoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativePointInTime"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a bound for a relative date range query.","plainTextDescription":"Specifies a bound for a relative date range query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a parameter matching the given parameter rid.","plainTextDescription":"Returns action types with a parameter matching the given parameter rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyPropertySelector"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Specifies the primary key property of an object type which is present on all object types.","plainTextDescription":"Specifies the primary key property of an object type which is present on all object types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeLinkedEntityApiName"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"}}}},"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked entity. This can either be an object or an interface type.","plainTextDescription":"A reference to the linked entity. This can either be an object or an interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyExpression"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MethodObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyOperation"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Definition for a selected property over a MethodObjectSet.","plainTextDescription":"Definition for a selected property over a MethodObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiNames"},"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of directed link type API names.","plainTextDescription":"A list of directed link type API names.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the **Ontology Manager**.\n","plainTextDescription":"The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied.\nParameters can be viewed and managed in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeVisibility"},"type":{"type":"enum","enum":{"values":["NORMAL","PROMINENT","HIDDEN"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The description of the interface.","plainTextDescription":"The description of the interface.","example":[]}},"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has. A shared property type must be unique across all of the properties.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"allProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has, including properties from all directly and indirectly extended \ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.\n","plainTextDescription":"A map from a shared property type API name to the corresponding shared property type. The map describes the\nset of properties the interface has, including properties from all directly and indirectly extended\ninterfaces.\nThis field only includes properties on the interface that are backed by shared property types.","example":[]}},"propertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has. An interface property can either be backed by a shared\nproperty or it can be defined directly on the interface.","example":[]}},"allPropertiesV2":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ResolvedInterfacePropertyType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.\n","plainTextDescription":"A map from a interface property type API name to the corresponding interface property type. The map\ndescribes the set of properties the interface has, including properties from all directly and indirectly\nextended interfaces.","example":[]}},"extendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n","plainTextDescription":"A list of interface API names that this interface extends. An interface can extend other interfaces to\ninherit their properties.","example":[]}},"allExtendsInterfaces":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface API names that this interface extends, both directly and indirectly.\n","plainTextDescription":"A list of interface API names that this interface extends, both directly and indirectly.","example":[]}},"implementedByObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object API names that implement this interface.\n","plainTextDescription":"A list of object API names that implement this interface.","example":[]}},"links":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has.","example":[]}},"allLinks":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkType"}}}}},"safety":"UNSAFE","documentation":{"description":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.\n","plainTextDescription":"A map from an interface link type API name to the corresponding interface link type. The map describes the\nset of link types the interface has, including links from all directly and indirectly extended interfaces.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an interface type in the Ontology.","plainTextDescription":"Represents an interface type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier for an action.","plainTextDescription":"The unique resource identifier for an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeLogicRuleTypeFilter"},"type":{"type":"enum","enum":{"values":["ADD_OBJECT","MODIFY_OBJECT","DELETE_OBJECT","ADD_LINK","DELETE_LINK","FUNCTION","BATCHED_FUNCTION","ADD_OR_MODIFY_OBJECT","ADD_OR_MODIFY_OBJECT_V2"]}},"safety":"SAFE","documentation":{"description":"Filter action types by the type of logic rule they contain.","plainTextDescription":"Filter action types by the type of logic rule they contain.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterface"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"},"type":{"type":"object","object":{"properties":{"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"deadline":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"example":[]}},"replacedBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.\n","plainTextDescription":"This status indicates that the PropertyType is reaching the end of its life and will be removed as per the\ndeadline specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a link type. To find the ID for your link type, check the **Ontology Manager** application.\n","plainTextDescription":"The unique ID of a link type. To find the ID for your link type, check the Ontology Manager application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the \n[Ontology Manager](/docs/foundry/ontology-manager/overview/).\n","plainTextDescription":"The name of the interface link type in the API. To find the API name for your Interface Link Type, check the\nOntology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"},"type":{"type":"object","object":{"properties":{"configuredFailureMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The message indicating one of the **submission criteria** was not satisfied.\nThis is configured per **submission criteria** in the **Ontology Manager**.\n","plainTextDescription":"The message indicating one of the submission criteria was not satisfied.\nThis is configured per submission criteria in the Ontology Manager.","example":[]}},"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Contains the status of the **submission criteria**.\n**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the **Ontology Manager**.\n","plainTextDescription":"Contains the status of the submission criteria.\nSubmission criteria are the prerequisites that need to be satisfied before an Action can be applied.\nThese are configured in the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherTextProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceObjectRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExtractPropertyExpression"},"type":{"type":"object","object":{"properties":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}},"safety":"UNSAFE","documentation":{"example":[]}},"part":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExtractDatePart"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Extracts the specified date part from a date or timestamp.\n","plainTextDescription":"Extracts the specified date part from a date or timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValueV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"dateValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DateValue"}}}},"stringValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringValue"}}}},"timestampValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"}}}},"booleanValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BooleanValue"}}}},"integerValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntegerValue"}}}},"doubleValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DoubleValue"}}}},"longValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LongValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameSelector"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property api name that references properties to query on.","plainTextDescription":"A property api name that references properties to query on.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an action section, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasActionLogActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they have an action log.","plainTextDescription":"Returns action types based on whether they have an action log.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"geopoint":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoPointType"}}}},"geotimeSeriesReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeotimeSeriesReferenceType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"geoshape":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GeoShapeType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"timeseries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimeseriesType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"vector":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VectorType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Object properties.\n","plainTextDescription":"A union of all the types supported by Ontology Object properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Formats the duration in a timecode format.","plainTextDescription":"Formats the duration in a timecode format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"},"type":{"type":"object","object":{"properties":{"objectPrimaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPrimaryKeyV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"operationId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The user ID or principal that performed the action","plainTextDescription":"The user ID or principal that performed the action","example":[]}},"timestamp":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"When this edit occurred (ISO 8601 format)","plainTextDescription":"When this edit occurred (ISO 8601 format)","example":[]}},"edit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.\n","plainTextDescription":"Represents a single object edit operation in the history. This captures when an object was\ncreated, modified, or deleted as part of an action execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterV2"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of an action.","plainTextDescription":"Details about a parameter of an action.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimestampValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesFullMetadataResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamingOutputFormat"},"type":{"type":"enum","enum":{"values":["JSON","ARROW"]}},"safety":"SAFE","documentation":{"description":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.\n","plainTextDescription":"Which format to serialize the binary stream in.\nARROW is more efficient for streaming a large sized response.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListObjectsForInterfaceResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of interface instances in the current page.","plainTextDescription":"The list of interface instances in the current page.","example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterConstraintValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"static":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StaticConstraintValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The source of a constraint bound value.","plainTextDescription":"The source of a constraint bound value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"optional":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeOptionalType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeUnionType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"reference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeReferenceType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeArrayType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeDecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the Query in the API.\n","plainTextDescription":"The name of the Query in the API.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueType"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. |\n| Attachment | `Attachment` |\n| Boolean | `Boolean` |\n| Byte | `Byte` |\n| CipherText | `CipherText` |\n| Date | `LocalDate` |\n| Decimal | `Decimal` |\n| Double | `Double` |\n| Float | `Float` |\n| Integer | `Integer` |\n| Long | `Long` |\n| Marking | `Marking` |\n| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. |\n| Short | `Short` |\n| String | `String` |\n| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` |\n| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. |\n| Timestamp | `Timestamp` |\n","plainTextDescription":"A string indicating the type of each data value. Note that these types can be nested, for example an array of\nstructs.\n| Type | JSON value |\n|---------------------|-------------------------------------------------------------------------------------------------------------------|\n| Array | Array, where T is the type of the array elements, e.g. Array. |\n| Attachment | Attachment |\n| Boolean | Boolean |\n| Byte | Byte |\n| CipherText | CipherText |\n| Date | LocalDate |\n| Decimal | Decimal |\n| Double | Double |\n| Float | Float |\n| Integer | Integer |\n| Long | Long |\n| Marking | Marking |\n| OntologyObject | OntologyObject where T is the API name of the referenced object type. |\n| Short | Short |\n| String | String |\n| Struct | Struct where T contains field name and type pairs, e.g. Struct<{ firstName: String, lastName: string }> |\n| Timeseries | TimeSeries where T is either String for an enum series or Double for a numeric series. |\n| Timestamp | Timestamp |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"},"type":{"type":"object","object":{"properties":{"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"KnownType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Formatting configuration for known Foundry types.","plainTextDescription":"Formatting configuration for known Foundry types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedInterfaceTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked interface type.","plainTextDescription":"A reference to the linked interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Error"},"type":{"type":"object","object":{"properties":{"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"}}},"safety":"SAFE","documentation":{"example":[]}},"args":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Arg"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The RID of a Foundry stream.","plainTextDescription":"The RID of a Foundry stream.","example":["ri.foundry.main.stream.f7e91c94-1cb2-4e34-8fdb-3da7c1a91e8b"]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponseV2"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObject"},"type":{"type":"object","object":{"properties":{"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceSharedPropertyType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"A short text that describes the SharedPropertyType.","plainTextDescription":"A short text that describes the SharedPropertyType.","example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueFormatting":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether each implementing object type must declare an implementation for this property.\n","plainTextDescription":"Whether each implementing object type must declare an implementation for this property.","example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.\n","plainTextDescription":"A shared property type with an additional field to indicate whether the property must be included on every\nobject type that implements the interface, or whether it is optional.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"rid","rid":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"validation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"edits":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CurrentUserArgument"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Represents the current user argument in a logic rule.","plainTextDescription":"Represents the current user argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CustomTypeId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A UUID representing a custom type in a given Function.\n","plainTextDescription":"A UUID representing a custom type in a given Function.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeDescriptionActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types with a description matching the given string predicate.","plainTextDescription":"Returns action types with a description matching the given string predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructField"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListScenarioEditedEntityTypesResponse"},"type":{"type":"object","object":{"properties":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of object type API names that have been modified within the scenario.","plainTextDescription":"The list of object type API names that have been modified within the scenario.","example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of edited link types grouped by source object type.\n\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.\n","plainTextDescription":"The list of edited link types grouped by source object type.\nNote that only many-to-many link types are returned. One-to-many link type edits are surfaced as object\nedits on the object type that owns the foreign key property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The object types and link types that have been modified within a scenario.\n","plainTextDescription":"The object types and link types that have been modified within a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedTimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"templateRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateRid"}}},"safety":"SAFE","documentation":{"example":[]}},"templateVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeseriesTemplateVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a time series property backed by a derived time series calculated with a formula.","plainTextDescription":"The representation of a time series property backed by a derived time series calculated with a formula.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS","QUARTERS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeStatus"}}}}},"safety":"SAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeFieldType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"constraints":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeConstraint"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NestedInterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.\n","plainTextDescription":"Describes how an object type implements an interface property when a reducer is applied to it. Is missing a\nreduced property implementation to prevent arbitrarily nested implementations.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchRequestElement"},"type":{"type":"object","object":{"properties":{"actionTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a property.","plainTextDescription":"The unique resource identifier of a property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RegexConstraint"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"partialMatch":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchActionObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a classification or mandatory marking.","plainTextDescription":"The id of a classification or mandatory marking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types which use the function with the given rid.","plainTextDescription":"Returns action types which use the function with the given rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdates"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}},"updates":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetUpdate"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequest"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Aggregation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"query":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQuery"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupBy"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsRequestV2"},"type":{"type":"object","object":{"properties":{"aggregation":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"groupBy":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"accuracy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationV2"},"type":{"type":"asyncOperation","asyncOperation":{"operationType":"applyActionAsyncV2","resultType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"}},"stageType":{"locator":{"namespaceName":"Ontologies","localName":"AsyncActionStatus"}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field.","plainTextDescription":"Returns objects based on the existence of the specified field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueFormattingRule"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyDateFormattingRule"}}}},"number":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRule"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyBooleanFormattingRule"}}}},"knownType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyKnownTypeFormattingRule"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTimestampFormattingRule"}}}}}}},"safety":"UNSAFE","documentation":{"description":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces. \nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\n\nEach formatter type provides specific options tailored to that data type:\n- Numbers: Support for percentages, currencies, units, scaling, and custom formatting\n- Dates/Timestamps: Localized and custom formatting patterns\n- Booleans: Custom true/false display text\n- Known types: Special formatting for Foundry-specific identifiers\n","plainTextDescription":"This feature is experimental and may change in a future release.\nComprehensive formatting configuration for displaying property values in user interfaces.\nSupports different value types including numbers, dates, timestamps, booleans, and known Foundry types.\nEach formatter type provides specific options tailored to that data type:\n\nNumbers: Support for percentages, currencies, units, scaling, and custom formatting\nDates/Timestamps: Localized and custom formatting patterns\nBooleans: Custom true/false display text\nKnown types: Special formatting for Foundry-specific identifiers","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MatchRule"},"type":{"type":"object","object":{"properties":{"query":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGaps":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.\n","plainTextDescription":"The maximum gaps between matched terms in the interval. For example, in the text \"quick brown fox\",\nthe terms \"quick\" and \"fox\" have a gap of one. If not set, then gaps are not considered.","example":[]}},"ordered":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"If true, the matched terms must occur in order.","plainTextDescription":"If true, the matched terms must occur in order.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals containing the terms in the query\n","plainTextDescription":"Matches intervals containing the terms in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypePermissionModelFilter"},"type":{"type":"enum","enum":{"values":["DATASOURCE_DERIVED_PERMISSIONS","ONTOLOGY_ROLES","COMPASS_PROJECT"]}},"safety":"SAFE","documentation":{"description":"Filter action types by permission model.","plainTextDescription":"Filter action types by permission model.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaReferenceProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PostTransactionEditsResponse"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertySumAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"},"type":{"type":"object","object":{"properties":{"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A possible value for the parameter.","plainTextDescription":"A possible value for the parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by query aggregation keys.\n","plainTextDescription":"A union of all the types supported by query aggregation keys.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DateValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"date","date":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyValueEscapedString"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"Represents the value of a property in string format. This is used in URL parameters.","plainTextDescription":"Represents the value of a property in string format. This is used in URL parameters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateTemporaryObjectSetRequestV2"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"},"type":{"type":"enum","enum":{"values":["USER_CLOSED","CHANNEL_CLOSED"]}},"safety":"SAFE","documentation":{"description":"Represents the reason a subscription was closed.\n","plainTextDescription":"Represents the reason a subscription was closed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WebhookRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of a webhook, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorComputingSecurity"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"Indicates the server was not able to load the securities of the property.","plainTextDescription":"Indicates the server was not able to load the securities of the property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupByV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationDurationGroupingV2"}}}},"fixedWidth":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"}}}},"ranges":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangesGroupingV2"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a grouping for aggregation results.","plainTextDescription":"Specifies a grouping for aggregation results.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateOrModifyObjectLogicRuleV2"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldOfPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObject"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current Page.","plainTextDescription":"The list of objects in the current Page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"computeUsage":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ComputeSeconds"}}}}},"safety":"SAFE","documentation":{"example":[]}},"propertySecurities":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertySecurities"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`.","plainTextDescription":"Represents the API response when loading an ObjectSet.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"constant":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringConstant"}}}},"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReference"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentProperty"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"The representation of an attachment as a data type.","plainTextDescription":"The representation of an attachment as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateInterfaceLogicRule"},"type":{"type":"object","object":{"properties":{"interfaceTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sharedPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager**\napplication and assign them API names. In every other case, API names should be used instead of property IDs.\n","plainTextDescription":"The immutable ID of a property. Property IDs are only used to identify properties in the Ontology Manager\napplication and assign them API names. In every other case, API names should be used instead of property IDs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeSeriesTimeUnit"},"type":{"type":"enum","enum":{"values":["MILLISECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS","MONTHS","YEARS"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBase"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The base used to initialize a scenario.","plainTextDescription":"The base used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyStructType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologySetType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"byte":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ByteType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"any":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AnyType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"cipherText":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CipherTextType"}}}},"marking":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MarkingType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"binary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BinaryType"}}}},"short":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ShortType"}}}},"decimal":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DecimalType"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyMapType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the primitive types used by Palantir's Ontology-based products.\n","plainTextDescription":"A union of all the primitive types used by Palantir's Ontology-based products.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetActionTypeByRidBatchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsHistoryResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditHistoryEntry"}}}}},"safety":"UNSAFE","documentation":{"description":"List of historical edits for this object type","plainTextDescription":"List of historical edits for this object type","example":[]}},"totalCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"Count of items in the data array above","plainTextDescription":"Count of items in the data array above","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Token for retrieving the next page of results","plainTextDescription":"Token for retrieving the next page of results","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.\n","plainTextDescription":"Response containing the history of edits for objects of a specific object type.\nOnly contains object edits (create, modify, delete) - link edits are not included.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BlueprintIcon"},"type":{"type":"object","object":{"properties":{"color":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A hexadecimal color code.","plainTextDescription":"A hexadecimal color code.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. \nUsed to specify the Blueprint icon to represent the object type in a React app.\n","plainTextDescription":"The name of the Blueprint icon.\nUsed to specify the Blueprint icon to represent the object type in a React app.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"reducers":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"}}}}},"safety":"UNSAFE","documentation":{"description":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.\n","plainTextDescription":"If non-empty, this property can be reduced to a single value of the subtype. The reducers are applied in\norder to determine a winning value. The array can be loaded as a reduced value or as the full array in an\nobject set.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructConstraint"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A map of the properties of the struct type to the value type applied to that property.","plainTextDescription":"A map of the properties of the struct type to the value type applied to that property.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionSuccess"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeStringFormat"},"type":{"type":"object","object":{"properties":{"pattern":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A valid format string composed of date/time patterns.","plainTextDescription":"A valid format string composed of date/time patterns.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A strictly specified date format pattern.","plainTextDescription":"A strictly specified date format pattern.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetV2ObjectsOrInterfacesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of objects in the current page.","plainTextDescription":"The list of objects in the current page.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"totalCount":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TotalCount"}}},"safety":"SAFE","documentation":{"example":[]}},"transactionId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyTransactionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents the API response when loading an `ObjectSet`. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.\n","plainTextDescription":"Represents the API response when loading an ObjectSet. Objects in the returned set can either have properties\ndefined by an interface that the objects belong to or properties defined by the object type of the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"absolute":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AbsoluteTimeRange"}}}},"relative":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RelativeTimeRange"}}}}}}},"safety":"UNSAFE","documentation":{"description":"An absolute or relative range for a time series query.","plainTextDescription":"An absolute or relative range for a time series query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LegacyPropertyId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the **Ontology Manager**.\n","plainTextDescription":"The unique ID of a property. This is a legacy identifier and is not recommended for use in new applications.\nTo find the ID for your property, check the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"},"type":{"type":"object","object":{"properties":{"mapping":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter value must be a property value of an object found within an object set.\n","plainTextDescription":"The parameter value must be a property value of an object found within an object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SumAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the sum of values for the provided field.","plainTextDescription":"Computes the sum of values for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LongValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.\n","plainTextDescription":"Matches strings which contain the given string or parts of the given string. The exact behaviour can vary\ndepending on the attribute searched for due to optimized text analysis.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyBaseBranch"},"type":{"type":"object","object":{"properties":{"branch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FoundryBranch"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A branch reference used to initialize a scenario.","plainTextDescription":"A branch reference used to initialize a scenario.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeCardinality"},"type":{"type":"enum","enum":{"values":["ONE","MANY"]}},"safety":"SAFE","documentation":{"description":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.\n","plainTextDescription":"The cardinality of the link in the given direction. Cardinality can be \"ONE\", meaning an object can\nlink to zero or one other objects, or \"MANY\", meaning an object can link to any number of other objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"},"type":{"type":"object","object":{"properties":{"keyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationKeyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregationValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyArrayType"},"type":{"type":"object","object":{"properties":{"itemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WildcardQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["fo*o"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field matches the wildcard pattern provided.\nEither `field` or `propertyIdentifier` can be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field matches the wildcard pattern provided.\nEither field or propertyIdentifier can be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Action"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNumberFormattingRuleType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"standard":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandard"}}}},"duration":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatDuration"}}}},"fixedValues":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatFixedValues"}}}},"affix":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatAffix"}}}},"scale":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatScale"}}}},"currency":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCurrency"}}}},"standardUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"}}}},"customUnit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatCustomUnit"}}}},"ratio":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatRatio"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyMaxAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToDelete":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetObjectTypeFullMetadataBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}},"includeLinkTypes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all outgoing link types for each requested object type in that object type's\n`linkTypes`. When false or omitted, `linkTypes` is empty.\n","plainTextDescription":"A flag that will return all outgoing link types for each requested object type in that object type's\nlinkTypes. When false or omitted, linkTypes is empty.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryAggregation"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MaxAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the maximum value for the provided field.","plainTextDescription":"Computes the maximum value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CountAggregationV2"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OrderByDirection"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the total count of objects.","plainTextDescription":"Computes the total count of objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceBaseType"},"type":{"type":"object","object":{"properties":{"interfaceType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"An object set with objects that implement the interface with the given interface API name. The objects in \nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.\n","plainTextDescription":"An object set with objects that implement the interface with the given interface API name. The objects in\nthe object set will only have properties that implement properties of the given interface, unless you set the includeAllBaseObjectProperties flag.","example":[]}},"includeAllBaseObjectProperties":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"A flag that will return all of the underlying object properties for the objects that implement the interface. \nThis includes properties that don't explicitly implement an SPT on the interface.\n","plainTextDescription":"A flag that will return all of the underlying object properties for the objects that implement the interface.\nThis includes properties that don't explicitly implement an SPT on the interface.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"},"type":{"type":"object","object":{"properties":{"subType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectState"},"type":{"type":"enum","enum":{"values":["ADDED_OR_UPDATED","REMOVED"]}},"safety":"SAFE","documentation":{"description":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was \nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object \nwas removed from the set due to the object being deleted or the object no longer meets the object set \ndefinition.\n","plainTextDescription":"Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was\nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object\nwas removed from the set due to the object being deleted or the object no longer meets the object set\ndefinition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducer"},"type":{"type":"object","object":{"properties":{"direction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"}}},"safety":"SAFE","documentation":{"example":[]}},"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of a geotime integration.","plainTextDescription":"The unique resource identifier of a geotime integration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SecuredPropertyValue"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertySecurityIndex":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetAsBaseObjectTypesType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.\n","plainTextDescription":"Casts the objects in the object set to their base type and thus ensures objects are returned with all of their\nproperties in the resulting object set, not just the properties that implement interface properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationOrderBy"},"type":{"type":"object","object":{"properties":{"metricName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GreatestPropertyExpression"},"type":{"type":"object","object":{"properties":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyDefinition"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Finds greatest of two or more numeric, date or timestamp values.\n","plainTextDescription":"Finds greatest of two or more numeric, date or timestamp values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementationMapping"},"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyOrStructFieldOfPropertyImplementation"}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.\n","plainTextDescription":"An implementation of a struct interface property via a local struct property. Specifies a mapping of interface\nstruct fields to local struct fields or properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchActionTypesOrderByV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeSortByV2"}}},"safety":"SAFE","documentation":{"example":[]}},"direction":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering direction (can be either `asc` or `desc`)","plainTextDescription":"Specifies the ordering direction (can be either asc or desc)","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.\n","plainTextDescription":"Specifies the ordering of action type search results by a field and an ordering direction. If not provided,\nresults are ordered by relevance of the match.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FuzzyV2"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesProperty"},"type":{"type":"object","object":{"properties":{"geotimeSeriesId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"geotimeSeriesIntegrationRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesIntegrationRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of a geotime series integration as a data type.","plainTextDescription":"The representation of a geotime series integration as a data type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The API name or RID of the Ontology. To find the API name or RID, use the **List Ontologies** endpoint or\ncheck the **Ontology Manager**.\n","plainTextDescription":"The API name or RID of the Ontology. To find the API name or RID, use the List Ontologies endpoint or\ncheck the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyRequest"},"type":{"type":"enum","enum":{"values":["REQUIRE_ACCURATE","ALLOW_APPROXIMATE"]}},"safety":"SAFE","documentation":{"description":"Specifies the accuracy requirement for aggregation results.\n\n- `REQUIRE_ACCURATE`: Only return results if they are guaranteed to be accurate. If accuracy cannot be\n guaranteed (e.g., due to a low `maxGroupCount` relative to distinct values), the request will fail\n with an `AggregationAccuracyNotSupported` error.\n- `ALLOW_APPROXIMATE`: Allow approximate results when exact computation is not feasible. This is the\n default behavior if not specified.\n","plainTextDescription":"Specifies the accuracy requirement for aggregation results.\n\nREQUIRE_ACCURATE: Only return results if they are guaranteed to be accurate. If accuracy cannot be\nguaranteed (e.g., due to a low maxGroupCount relative to distinct values), the request will fail\nwith an AggregationAccuracyNotSupported error.\nALLOW_APPROXIMATE: Allow approximate results when exact computation is not feasible. This is the\ndefault behavior if not specified.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LtQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is less than a value.","plainTextDescription":"Returns objects where the specified field is less than a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EncryptionResult"},"type":{"type":"object","object":{"properties":{"ciphertext":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CipherText"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.\n","plainTextDescription":"The result of a CipherText encryption. If successful, the encrypted ciphertext value will be returned. Otherwise, an error will be thrown.","example":[{"ciphertext":"CIPHER::ri.bellaso.main.cipher-channel.x::::CIPHER"}]}},{"locator":{"namespaceName":"Ontologies","localName":"ModifyObjectLogicRule"},"type":{"type":"object","object":{"properties":{"objectToModify":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"structPropertyArguments":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeReferenceIdentifier"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the `typeReferences` map of the enclosing Query.\n","plainTextDescription":"The unique identifier of a type reference. This identifier is used to look up the\ntype definition in the typeReferences map of the enclosing Query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"},"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"},"type":{"type":"object","object":{"properties":{"mediaSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetRid"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaSetViewRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaSetViewRid"}}},"safety":"SAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The set of properties that are bound to the media view.\n","plainTextDescription":"The set of properties that are bound to the media view.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.\n","plainTextDescription":"An object type datasource backed by a Foundry media set view, providing media for media reference properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinksFromObject"},"type":{"type":"object","object":{"properties":{"sourceObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjects":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The Ontology Objects in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"The Ontology Objects in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectV2"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchObjectsForInterfaceRequest"},"type":{"type":"object","object":{"properties":{"where":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"augmentedProperties":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from object type API name to a list of property type API names. For each returned object, if the \nobject’s object type is a key in the map, then we augment the response for that object type with the list \nof properties specified in the value.\n","plainTextDescription":"A map from object type API name to a list of property type API names. For each returned object, if the\nobject’s object type is a key in the map, then we augment the response for that object type with the list\nof properties specified in the value.","example":[]}},"augmentedSharedPropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"augmentedInterfacePropertyTypes":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A map from interface type API name to a list of interface property type API names. For each returned object, \nif the object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n","plainTextDescription":"A map from interface type API name to a list of interface property type API names. For each returned object,\nif the object implements an interface that is a key in the map, then we augment the response for that object\ntype with the list of properties specified in the value.","example":[]}},"selectedSharedPropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of shared property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of shared property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedInterfacePropertyTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n","plainTextDescription":"A list of interface property type API names of the interface type that should be included in the response.\nOmit this parameter to include all properties of the interface type in the response.","example":[]}},"selectedObjectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the \nparameter to include all object types.\n","plainTextDescription":"A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the\nparameter to include all object types.","example":[]}},"otherInterfaceTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be \nincluded in the response.\n","plainTextDescription":"A list of interface type API names. Object types must implement all the mentioned interfaces in order to be\nincluded in the response.","example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"example":[]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StreamTimeSeriesValuesRequest"},"type":{"type":"object","object":{"properties":{"range":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeRange"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionResults"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"edits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectEdits"}}}},"largeScaleEdits":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEdits"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"},"type":{"type":"enum","enum":{"values":["VALID","INVALID"]}},"safety":"SAFE","documentation":{"description":"Represents the state of a validation.\n","plainTextDescription":"Represents the state of a validation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectLocator"},"type":{"type":"object","object":{"properties":{"targetObject":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe `targetObject` Ontology Object in this response will only ever have the `__primaryKey` and `__apiName` \nfields present, thus functioning as object locators rather than full objects.","plainTextDescription":"Does not contain information about the source object. Should be used in a nested type that provides information about source objects.\nThe targetObject Ontology Object in this response will only ever have the __primaryKey and __apiName\nfields present, thus functioning as object locators rather than full objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AvgAggregation"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateObjectsResponseItem"},"type":{"type":"object","object":{"properties":{"group":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metrics":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"KnownType"},"type":{"type":"enum","enum":{"values":["USER_OR_GROUP_ID","RESOURCE_RID","ARTIFACT_GID"]}},"safety":"SAFE","documentation":{"description":"Known Foundry types for specialized formatting:\n- userOrGroupRid: Format as user or group\n- resourceRid: Format as resource \n- artifactGid: Format as artifact\n","plainTextDescription":"Known Foundry types for specialized formatting:\n\nuserOrGroupRid: Format as user or group\nresourceRid: Format as resource\nartifactGid: Format as artifact","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValidateActionResponseV2"},"type":{"type":"object","object":{"properties":{"result":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValidationResult"}}},"safety":"SAFE","documentation":{"example":[]}},"submissionCriteria":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SubmissionCriteriaEvaluation"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluationResult"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HasWebhookActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types based on whether they reference a webhook.","plainTextDescription":"Returns action types based on whether they reference a webhook.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListInterfaceLinkedObjectsResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregateTimeSeries"},"type":{"type":"object","object":{"properties":{"method":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationMethod"}}},"safety":"SAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesAggregationStrategy"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"},"type":{"type":"object","object":{"properties":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"structParameterFieldApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents a struct parameter field argument in a logic rule.","plainTextDescription":"Represents a struct parameter field argument in a logic rule.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionLogicRule"},"type":{"type":"object","object":{"properties":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionInputValues":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionParameterName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRuleArgument"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructFieldTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"typeClasses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClass"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OneOfAllowedValues"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValueOption"}}}}},"safety":"UNSAFE","documentation":{"description":"The predefined set of options.","plainTextDescription":"The predefined set of options.","example":[]}},"otherValuesAllowed":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether values outside `options` are allowed.","plainTextDescription":"Whether values outside options are allowed.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The parameter value must be one of a fixed set of labelled options.","plainTextDescription":"The parameter value must be one of a fixed set of labelled options.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StartsWithQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo"]}}}}},"safety":"UNSAFE","documentation":{"description":"Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`, which is preferred because the name `startsWith` is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Deprecated alias for containsAllTermsInOrderPrefixLastTerm, which is preferred because the name startsWith is misleading.\nReturns objects where the specified field starts with the provided value. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"},"type":{"type":"object","object":{"properties":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An implementation of an interface property via a local property.","plainTextDescription":"An implementation of an interface property via a local property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionResponseV2"},"type":{"type":"object","object":{"properties":{"operationId":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"link":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationExactGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxGroupCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of groups to return. If omitted, defaults to 10,000.\n\nThe server allocates resources based on the specified `maxGroupCount`. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\n\nIf you need accurate results with high-cardinality properties, set `maxGroupCount` high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\n`excludedItems`. The response `accuracy` field indicates whether the results are `ACCURATE` or\n`APPROXIMATE`.\n","plainTextDescription":"The maximum number of groups to return. If omitted, defaults to 10,000.\nThe server allocates resources based on the specified maxGroupCount. When the number of distinct\nvalues in your data is within this limit, results are accurate and the top N values are returned\ncorrectly. When distinct values exceed what the allocated resources can handle, results may become\napproximate.\nIf you need accurate results with high-cardinality properties, set maxGroupCount high enough to\ncover your distinct values. Items exceeding the limit are excluded from results and counted in\nexcludedItems. The response accuracy field indicates whether the results are ACCURATE or\nAPPROXIMATE.","example":[]}},"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.\n","plainTextDescription":"Includes a group with the specified default value that includes all objects where the specified field's value is null.\nCannot be used with includeNullValues.","example":[]}},"includeNullValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.\n","plainTextDescription":"Includes a group with a null value that includes all objects where the specified field's value is null.\nCannot be used with defaultValue or orderBy clauses on the aggregation.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups according to an exact value.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups according to an exact value.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionExecutionTime"},"type":{"type":"builtin","builtin":{"type":"datetime","datetime":{}}},"safety":"SAFE","documentation":{"description":"An ISO 8601 timestamp.\n","plainTextDescription":"An ISO 8601 timestamp.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified array contains a value.","plainTextDescription":"Returns objects where the specified array contains a value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetMethodInputType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"ObjectSet which is the root of a MethodObjectSet definition.\n\nThis feature is experimental and not yet generally available.\n","plainTextDescription":"ObjectSet which is the root of a MethodObjectSet definition.\nThis feature is experimental and not yet generally available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyScenarioRule"},"type":{"type":"object","object":{"properties":{"scenarioParameter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeLinkTypeApiNameMapping"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\n\nThe scenario is supplied through the parameter identified by `scenarioParameter` of type\n`scenarioReference`. The affected object types and link types are explicitly enumerated in the scope.\n","plainTextDescription":"An Action rule that applies the edits accumulated on a referenced Scenario onto the ontology data context\nwhere the Action is applied. If the Action is applied in the context of main ontology data, the edits are\napplied there. If the Action is applied in the context of another Scenario, the edits are applied in that\nother Scenario.\nThe scenario is supplied through the parameter identified by scenarioParameter of type\nscenarioReference. The affected object types and link types are explicitly enumerated in the scope.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TypeClassesActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TypeClassPredicateV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns action types whose type class satisfies the given type class predicate.","plainTextDescription":"Returns action types whose type class satisfies the given type class predicate.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CreateObjectRule"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyWithLoadLevelSelector"},"type":{"type":"object","object":{"properties":{"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"loadLevel":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyLoadLevel"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.\n","plainTextDescription":"A combination of a property identifier and the load level to apply to the property. You can select a reduced\nvalue for arrays and the main value for structs. If the provided load level cannot be applied to the property\ntype, then it will be ignored. This selector is experimental and may not work in filters or sorts.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectTypeReferenceType"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListLinkedObjectsResponseV2"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectV2"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SeriesId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The unique codex id of a time series.","plainTextDescription":"The unique codex id of a time series.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeStatus"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deprecated":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeprecatedPropertyTypeStatus"}}}},"active":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActivePropertyTypeStatus"}}}},"experimental":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExperimentalPropertyTypeStatus"}}}},"example":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.\n","plainTextDescription":"The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyTypeImplementation"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structFieldImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructFieldImplementation"}}}},"structImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyStructImplementation"}}}},"localPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyLocalPropertyImplementation"}}}},"reducedPropertyImplementation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyReducedPropertyImplementation"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Describes how an object type implements an interface property.\n","plainTextDescription":"Describes how an object type implements an interface property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatStandardUnit"},"type":{"type":"object","object":{"properties":{"baseFormatOptions":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"}}},"safety":"SAFE","documentation":{"example":[]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeReferenceOrStringConstant"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"\n","plainTextDescription":"Format numbers with standard units supported by Intl.NumberFormat.\nExamples: \"meter\", \"kilogram\", \"celsius\", \"percent\"\nInput: 25 with unit \"celsius\" displays as \"25 degrees C\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseDuration"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The duration value.","plainTextDescription":"The duration value.","example":[30]}},"unit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A measurement of duration.","plainTextDescription":"A measurement of duration.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberScaleType"},"type":{"type":"enum","enum":{"values":["THOUSANDS","MILLIONS","BILLIONS"]}},"safety":"SAFE","documentation":{"description":"Scale factor options for large numbers:\n- THOUSANDS: Divide by 1,000 and add \"K\" suffix\n- MILLIONS: Divide by 1,000,000 and add \"M\" suffix\n- BILLIONS: Divide by 1,000,000,000 and add \"B\" suffix\n","plainTextDescription":"Scale factor options for large numbers:\n\nTHOUSANDS: Divide by 1,000 and add \"K\" suffix\nMILLIONS: Divide by 1,000,000 and add \"M\" suffix\nBILLIONS: Divide by 1,000,000,000 and add \"B\" suffix","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentV2"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"filename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"Filename"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sizeBytes":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"SizeBytes"}}},"safety":"SAFE","documentation":{"example":[]}},"mediaType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The representation of an attachment.","plainTextDescription":"The representation of an attachment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SubscriptionId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A unique identifier used to associate subscription requests with responses.","plainTextDescription":"A unique identifier used to associate subscription requests with responses.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditHistoryEdit"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"createEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"CreateEdit"}}}},"deleteEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DeleteEdit"}}}},"modifyEdit":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ModifyEdit"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringPredicateV2"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"contains":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringContainsPredicate"}}}},"exact":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FullTextStringExactPredicate"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A predicate for matching strings.","plainTextDescription":"A predicate for matching strings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterValidationBlock"},"type":{"type":"object","object":{"properties":{"allowedValues":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterAllowedValues"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"arraySize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterArraySize"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Validation constraints for a parameter.","plainTextDescription":"Validation constraints for a parameter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SectionRidActionTypesQueryV2"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionSectionRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Returns action types with a section matching the given section rid.","plainTextDescription":"Returns action types with a section matching the given section rid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"},"type":{"type":"object","object":{"properties":{"unsupportedType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A short, stable discriminator naming the underlying OMS variant. E.g., `\"derivedProperties\"` for\nderived-properties datasources or `\"unknown\"` for variants the adapter does not recognize.\n","plainTextDescription":"A short, stable discriminator naming the underlying OMS variant. E.g., \"derivedProperties\" for\nderived-properties datasources or \"unknown\" for variants the adapter does not recognize.","example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"description":"The property API names that this datasource backs.","plainTextDescription":"The property API names that this datasource backs.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datasource of a kind not yet exposed in the public API. The `unsupportedType` discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an `\"unknown\"` discriminator. The `properties` list\nenumerates the property API names this datasource backs. The `properties` will be empty for `\"unknown\"`\ndatasources.\n","plainTextDescription":"A datasource of a kind not yet exposed in the public API. The unsupportedType discriminator supplies the\nunderlying OMS variant so callers can recognize known but unmodelled cases (e.g., derived properties). Variants\nthe adapter does not recognise at all are returned with an \"unknown\" discriminator. The properties list\nenumerates the property API names this datasource backs. The properties will be empty for \"unknown\"\ndatasources.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RelativeDatetimeTense"},"type":{"type":"enum","enum":{"values":["FUTURE","PAST"]}},"safety":"SAFE","documentation":{"description":"Direction of a relative datetime offset.","plainTextDescription":"Direction of a relative datetime offset.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequest"},"type":{"type":"object","object":{"properties":{"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GetQueryTypeByRidBatchRequestElement"}}},"minItems":1,"maxItems":100}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"StructFieldArgument"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"structListParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructListParameterFieldArgument"}}}},"structParameterFieldValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructParameterFieldArgument"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an argument used for an individual struct field.\n","plainTextDescription":"Represents an argument used for an individual struct field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OrderBy"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by `p` or `properties`. The format expected format is\n`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...`\n\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending \n`:asc` (for ascending) or `:desc` (for descending).\n\nExample: use `orderBy=properties.lastName:asc` to order by a single property, \n`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. \nYou may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`.\n","plainTextDescription":"A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by p or properties. The format expected format is\norderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending\n:asc (for ascending) or :desc (for descending).\nExample: use orderBy=properties.lastName:asc to order by a single property,\norderBy=properties.lastName,properties.firstName,properties.age:desc to order by multiple properties.\nYou may also use the shorthand p instead of properties such as orderBy=p.lastName:asc.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IntersectsPolygonQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PolygonValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to \nquery on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field intersects the polygon provided. Allows you to specify a property to\nquery on by a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestV2"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}},"requests":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"BatchApplyActionRequestItem"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatasourceBranchId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.\n","plainTextDescription":"The id of a datasource branch. Branch ids are user supplied strings, not RIDs.","example":["master"]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainerDisjunctiveMarkingSummary"},"type":{"type":"list","list":{"subType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"MarkingId"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property \nAll markings from a conjunctive set must be met for access.\n\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be \ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.\n","plainTextDescription":"The disjunctive set of markings for the container of this property value,\nsuch as the project of a dataset. These markings may differ from the marking\non the actual property value, but still must be satisfied for accessing the property\n\nAll markings from a conjunctive set must be met for access.\nDisjunctive markings are represented as a conjunctive list of disjunctive sets.\nThe top-level set is a conjunction of sets, where each inner set should be\ntreated as a unit where any marking within the set can satisfy the set.\nAll sets within the top level set should be satisfied.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListActionTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryParameterV2"},"type":{"type":"object","object":{"properties":{"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"dataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"required":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Details about a parameter of a query.","plainTextDescription":"Details about a parameter of a query.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"WithinBoundingBoxPoint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"Point":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Geo","localName":"GeoPoint"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationRangeV2"},"type":{"type":"object","object":{"properties":{"startValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Inclusive start.","plainTextDescription":"Inclusive start.","example":[]}},"endValue":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"Exclusive end.","plainTextDescription":"Exclusive end.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies a range from an inclusive start value to an exclusive end value.","plainTextDescription":"Specifies a range from an inclusive start value to an exclusive end value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeFullMetadata"},"type":{"type":"object","object":{"properties":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeV2"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fullLogicRules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionLogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns the full metadata for an Action type in the Ontology.","plainTextDescription":"Returns the full metadata for an Action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyAvgAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Computes the average value for the provided field.","plainTextDescription":"Computes the average value for the provided field.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderBy"},"type":{"type":"object","object":{"properties":{"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrdering"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Specifies the ordering of search results by a field and an ordering direction.","plainTextDescription":"Specifies the ordering of search results by a field and an ordering direction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatOptions"},"type":{"type":"object","object":{"properties":{"useGrouping":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","plainTextDescription":"If true, show a locale-appropriate number grouping (e.g. thousands for en).","example":[]}},"convertNegativeToParenthesis":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, wrap negative numbers in parentheses instead of a minus sign.","plainTextDescription":"If true, wrap negative numbers in parentheses instead of a minus sign.","example":[]}},"minimumIntegerDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumFractionDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"minimumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"maximumSignificantDigits":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"notation":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberFormatNotation"}}}}},"safety":"SAFE","documentation":{"example":[]}},"roundingMode":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NumberRoundingMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\n\nExamples:\n- useGrouping: true makes 1234567 display as \"1,234,567\"\n- maximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\n- notation: SCIENTIFIC makes 1234 display as \"1.234E3\"\n","plainTextDescription":"Base number formatting options that can be applied to all number formatters.\nControls precision, grouping, rounding, and notation. Consistent with JavaScript's Intl.NumberFormat.\nExamples:\n\nuseGrouping: true makes 1234567 display as \"1,234,567\"\nmaximumFractionDigits: 2 makes 3.14159 display as \"3.14\"\nnotation: SCIENTIFIC makes 1234 display as \"1.234E3\"","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ErrorName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionType"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Parameter"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LogicRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Represents an action type in the Ontology.","plainTextDescription":"Represents an action type in the Ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReturnEditsMode"},"type":{"type":"enum","enum":{"values":["ALL","ALL_V2_WITH_DELETIONS","NONE"]}},"safety":"SAFE","documentation":{"description":"If not specified, defaults to `NONE`.","plainTextDescription":"If not specified, defaults to NONE.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ReferenceValue"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"geotimeSeriesValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GeotimeSeriesValue"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Resolved data values pointed to by a reference.","plainTextDescription":"Resolved data values pointed to by a reference.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an object, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetInterfaceLinkSearchAroundType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLink":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EqualsQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field is equal to a value.\n\nFor string properties, full term matching only works when **Selectable** is enabled for the property in Ontology Manager.\n","plainTextDescription":"Returns objects where the specified field is equal to a value.\nFor string properties, full term matching only works when Selectable is enabled for the property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ContainsAllTermsInOrderQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":["foo bar"]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects where the specified field contains all of the terms in the order provided,\nbut they do have to be adjacent to each other. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasourceDefinition"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"timeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTimeSeriesDatasource"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeUnsupportedDatasource"}}}},"restrictedView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRestrictedViewDatasource"}}}},"stream":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeStreamDatasource"}}}},"mediaSetView":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeMediaSetViewDatasource"}}}},"direct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDirectDatasource"}}}},"geotimeSeries":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeGeotimeSeriesDatasource"}}}},"editsOnly":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeEditsOnlyDatasource"}}}},"dataset":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDatasetDatasource"}}}},"table":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeTableDatasource"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.\n","plainTextDescription":"The definition of an object type datasource, identifying the kind of Foundry resource that backs the object\ntype.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DeleteLink"},"type":{"type":"object","object":{"properties":{"linkTypeApiNameAtoB":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeApiNameBtoA":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}},"bSideObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkSideObject"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AsyncApplyActionOperationResponseV2"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"date":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DateType"}}}},"interfaceObject":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectType"}}}},"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryStructType"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"StringType"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"IntegerType"}}}},"threeDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ThreeDimensionalAggregation"}}}},"float":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"FloatType"}}}},"long":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"LongType"}}}},"unsupported":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UnsupportedType"}}}},"attachment":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"AttachmentType"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryArrayType"}}}},"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectSetType"}}}},"twoDimensionalAggregation":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TwoDimensionalAggregation"}}}},"typeReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryTypeReferenceType"}}}},"timestamp":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"TimestampType"}}}},"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QuerySetType"}}}},"void":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"VoidType"}}}},"entrySet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"EntrySetType"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DoubleType"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryUnionType"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"BooleanType"}}}},"mediaReference":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"MediaReferenceType"}}}},"null":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"NullType"}}}},"interfaceObjectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyInterfaceObjectSetType"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A union of all the types supported by Ontology Query parameters or outputs.\n","plainTextDescription":"A union of all the types supported by Ontology Query parameters or outputs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ExamplePropertyTypeStatus"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.\n","plainTextDescription":"This status indicates that the PropertyType is an example. It is backed by notional data that should not be\nused for actual workflows, but can be used to test those workflows.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationFixedWidthGroupingV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fixedWidth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Divides objects into groups with the specified width.\nEither `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Divides objects into groups with the specified width.\nEither field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetFilterType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"where":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchJsonQueryV2"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the value type in the API in camelCase format.","plainTextDescription":"The name of the value type in the API in camelCase format.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOutgoingLinkTypesResponse"},"type":{"type":"object","object":{"properties":{"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageToken"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of link type sides in the current page.","plainTextDescription":"The list of link type sides in the current page.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationFormatStyle"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"humanReadable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"HumanReadableFormat"}}}},"timecode":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"TimeCodeFormat"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IsNullQueryV2"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"UNSAFE","documentation":{"example":[false]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both.\n","plainTextDescription":"Returns objects based on the existence of the specified field. Allows you to specify a property to query on\nby a variety of means. Either field or propertyIdentifier must be supplied, but not both.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.\n","plainTextDescription":"The unique resource identifier of an action type, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SelectedPropertyCollectListAggregation"},"type":{"type":"object","object":{"properties":{"selectedPropertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"limit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"Maximum number of values to collect. The maximum supported limit is 100.\n","plainTextDescription":"Maximum number of values to collect. The maximum supported limit is 100.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\n\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\n\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.\n","plainTextDescription":"Lists all values of a property up to the specified limit. The maximum supported limit is 100, by default.\nNOTE: A separate count aggregation should be used to determine the total count of values, to account for\na possible truncation of the returned list.\nIgnores objects for which a property is absent, so the returned list will contain non-null values only.\nReturns an empty list when none of the objects have values for a provided property.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponses"},"type":{"type":"object","object":{"properties":{"responses":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetSubscribeResponse"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RequestId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.\n","plainTextDescription":"Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ColumnPropertyMapping"},"type":{"type":"object","object":{"properties":{"column":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ColumnName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A property bound to a single column in the backing datasource.","plainTextDescription":"A property bound to a single column in the backing datasource.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PreciseTimeUnit"},"type":{"type":"enum","enum":{"values":["NANOSECONDS","SECONDS","MINUTES","HOURS","DAYS","WEEKS"]}},"safety":"SAFE","documentation":{"description":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","plainTextDescription":"The unit of a fixed-width duration. Each day is 24 hours and each week is 7 days.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EnumConstraint"},"type":{"type":"object","object":{"properties":{"options":{"type":{"type":"list","list":{"subType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyTermQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fuzzy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"Fuzzy"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n","plainTextDescription":"Returns objects where the specified field contains any of the whitespace separated words in any\norder in the provided value. This query supports fuzzy matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectTypeApiName"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to the linked object type.","plainTextDescription":"A reference to the linked object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectLocator"},"type":{"type":"object","object":{"properties":{"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKeyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An object identifier containing an object type API name and primary key.","plainTextDescription":"An object identifier containing an object type API name and primary key.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNearestNeighborsType"},"type":{"type":"object","object":{"properties":{"objectSet":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSet"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyIdentifier":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyIdentifier"}}},"safety":"UNSAFE","documentation":{"example":[]}},"numNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.\n","plainTextDescription":"The number of objects to return. If the number of documents in the objectType is less than the provided\nvalue, all objects will be returned. This value is limited to 1 <= numNeighbors <= 500.","example":[]}},"similarityThreshold":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"double","double":{}}}}},"safety":"SAFE","documentation":{"description":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.\n","plainTextDescription":"The similarity threshold results must be above to be included in the returned in the object set.\n0 <= Threshold <= 1. Where 1 is identical and 0 is least similar.","example":[]}},"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"NearestNeighborsQuery"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"ObjectSet containing the top `numNeighbors` objects with `propertyIdentifier` nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\n\nA non-zero score for each resulting object is returned when the `orderType` in the `orderBy` field is set to\n`relevance`. Note that:\n - Scores will not be returned if a nearestNeighbors object set is composed through union, subtraction \n or intersection with non-nearestNeighbors object sets.\n - If results have scores, the order of the scores will be decreasing (duplicate scores are possible).\n","plainTextDescription":"ObjectSet containing the top numNeighbors objects with propertyIdentifier nearest to the input vector or\ntext. This can only be performed on a property with type vector that has been configured to be searched with\napproximate nearest neighbors using a similarity function configured in the Ontology.\nA non-zero score for each resulting object is returned when the orderType in the orderBy field is set to\nrelevance. Note that:\n\nScores will not be returned if a nearestNeighbors object set is composed through union, subtraction\nor intersection with non-nearestNeighbors object sets.\nIf results have scores, the order of the scores will be decreasing (duplicate scores are possible).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"Reason"},"type":{"type":"object","object":{"properties":{"reason":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ReasonType"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracy"},"type":{"type":"enum","enum":{"values":["ACCURATE","APPROXIMATE"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelStrategy"},"type":{"type":"enum","enum":{"values":["PREFER_EXISTING","PREFER_DEFAULT","EXISTING_ONLY","DEFAULT_ONLY"]}},"safety":"SAFE","documentation":{"description":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to `PREFER_EXISTING`.\n\n- `PREFER_EXISTING`: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\n- `PREFER_DEFAULT`: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\n- `EXISTING_ONLY`: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\n- `DEFAULT_ONLY`: use the default channel configured in ontology metadata only; error if none is configured.\n","plainTextDescription":"Controls which Cipher Channel is used when encrypting a value. If not specified, defaults to PREFER_EXISTING.\n\nPREFER_EXISTING: use the Cipher Channel parsed from the existing ciphertext value; fall back to the default channel configured in ontology metadata.\nPREFER_DEFAULT: use the default channel configured in ontology metadata; fall back to the channel parsed from the existing ciphertext value.\nEXISTING_ONLY: use the channel parsed from the existing ciphertext value only; error if the value is not already encrypted.\nDEFAULT_ONLY: use the default channel configured in ontology metadata only; error if none is configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSide"},"type":{"type":"object","object":{"properties":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"displayName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"DisplayName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"ReleaseStatus"}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"cardinality":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeSideCardinality"}}},"safety":"SAFE","documentation":{"example":[]}},"foreignKeyPropertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","plainTextDescription":"The unique resource identifier of an interface, useful for interacting with other Foundry APIs.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.\n","plainTextDescription":"The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated.\nThis can happen when a parameter's allowed values are defined by another parameter that is missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AnyOfRule"},"type":{"type":"object","object":{"properties":{"rules":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"IntervalQueryRule"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Matches intervals satisfying any of the rules in the query\n","plainTextDescription":"Matches intervals satisfying any of the rules in the query","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterEvaluatedConstraint"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"struct":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StructEvaluatedConstraint"}}}},"oneOf":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OneOfConstraint"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArrayEvaluatedConstraint"}}}},"groupMember":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"GroupMemberConstraint"}}}},"objectPropertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectPropertyValueConstraint"}}}},"range":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"RangeConstraint"}}}},"arraySize":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArraySizeConstraint"}}}},"objectQueryResult":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectQueryResultConstraint"}}}},"stringLength":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringLengthConstraint"}}}},"stringRegexMatch":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"StringRegexMatchConstraint"}}}},"unevaluable":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UnevaluableConstraint"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. |\n| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. |\n| `oneOf` | The parameter has a manually predefined set of options. |\n| `range` | The parameter value must be within the defined range. |\n| `stringLength` | The parameter value must have a length within the defined range. |\n| `stringRegexMatch` | The parameter value must match a predefined regular expression. |\n| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |\n","plainTextDescription":"A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the Ontology Manager.\nApplicable constraints are determined dynamically based on parameter inputs.\nParameter values are evaluated against the final set of constraints.\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| arraySize | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| groupMember | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| objectPropertyValue | The parameter value must be a property value of an object found within an object set. |\n| objectQueryResult | The parameter value must be the primary key of an object found within an object set. |\n| oneOf | The parameter has a manually predefined set of options. |\n| range | The parameter value must be within the defined range. |\n| stringLength | The parameter value must have a length within the defined range. |\n| stringRegexMatch | The parameter value must match a predefined regular expression. |\n| unevaluable | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TimeSeriesValueBankProperty"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologiesV2Response"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyV2"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of Ontologies the user has access to.","plainTextDescription":"The list of Ontologies the user has access to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherText"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A value encrypted with [Cipher](/docs/foundry/cipher/overview/), stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example `CIPHER::{cipherChannelRid}::::CIPHER`).\n","plainTextDescription":"A value encrypted with Cipher, stored in its envelope form which encodes\nthe Cipher Channel used to encrypt it (for example CIPHER::{cipherChannelRid}::::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyObjectArrayTypeReducerSortDirection"},"type":{"type":"enum","enum":{"values":["ASCENDING_NULLS_LAST","DESCENDING_NULLS_LAST"]}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ListOntologyValueTypesResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DurationBaseValue"},"type":{"type":"enum","enum":{"values":["SECONDS","MILLISECONDS"]}},"safety":"SAFE","documentation":{"description":"Specifies the unit of the input duration value.","plainTextDescription":"Specifies the unit of the input duration value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DatetimeLocalizedFormatType"},"type":{"type":"enum","enum":{"values":["DATE_FORMAT_RELATIVE_TO_NOW","DATE_FORMAT_DATE","DATE_FORMAT_YEAR_AND_MONTH","DATE_FORMAT_DATE_TIME","DATE_FORMAT_DATE_TIME_SHORT","DATE_FORMAT_TIME","DATE_FORMAT_ISO_INSTANT"]}},"safety":"SAFE","documentation":{"description":"Localized date/time format types.","plainTextDescription":"Localized date/time format types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PrefixQuery"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FieldNameV1"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Returns objects where the specified field starts with the provided value.","plainTextDescription":"Returns objects where the specified field starts with the provided value.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequest"},"type":{"type":"object","object":{"properties":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"valueType":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}}],"errors":[{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action type is not found, or the user does not have access to it.","plainTextDescription":"The action type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MalformedPropertyFilters"},"errorType":"INVALID_ARGUMENT","parameters":{"malformedPropertyFilter":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`.\n","plainTextDescription":"At least one of requested filters are malformed. Please look at the documentation of PropertyFilter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValue"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyEditsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"editsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"editsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.\n","plainTextDescription":"The number of edits to the Ontology exceeded the allowed limit.\nThis may happen because of the request or because the Action is modifying too many objects.\nPlease change the size of your request or contact the Ontology administrator.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotSynced"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.\n","plainTextDescription":"The requested object type is not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleMediaUploadDestinations"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.\n","plainTextDescription":"The media reference property has multiple media set views marked as upload destinations. At most one media\nsource per property should be configured as the upload destination. This typically indicates an inconsistent\nobject type configuration; review the backing media sources for this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an object type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an object type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationGroupCountExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"groupsCount":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"groupsLimit":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiNamesNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"derivedPropertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested derived property API names already exist on the object set.","plainTextDescription":"At least one of the requested derived property API names already exist on the object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterInterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter references an interface type that could not be found, or the client token does not have access to it.\n","plainTextDescription":"The parameter references an interface type that could not be found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedInterfaceBasedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","plainTextDescription":"Aggregations on interface-based object sets are not supported for object sets with OSv1 objects.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkLinkMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given link could not be mapped to a Marketplace installation.","plainTextDescription":"The given link could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionNotFound"},"errorType":"NOT_FOUND","parameters":{"actionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The action is not found, or the user does not have access to it.","plainTextDescription":"The action is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnknownParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"expectedParameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameters were not found. Please look at the `knownParameters` field\nto see which ones are available.\n","plainTextDescription":"The provided parameters were not found. Please look at the knownParameters field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionNotSupportedWithTransaction"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The function runtime does not support execution with a transaction.\n","plainTextDescription":"The function runtime does not support execution with a transaction.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectSetRidNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object set RID is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object set RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByValue"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.\n","plainTextDescription":"Duration groupBy value is invalid. Units larger than day must have value 1 and date properties do not support\nfiltering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by\nevery two hours are allowed.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeDerivedPropertyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.\n","plainTextDescription":"The request uses an object type derived property in a way that is not supported. This occurs when results\nare sorted by the derived property, when the object set is filtered on the derived property, or when the\nderived property is returned only because the request asked for all properties of the object type (rather\nthan naming it explicitly). To resolve this, remove the derived property from the sort ordering and from any\nfilters, and select only the specific properties you need - you may select the derived property itself by\nname.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentType"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The `Content-Type` cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.\n","plainTextDescription":"The Content-Type cannot be inferred from the request content and filename.\nPlease check your request content and filename to ensure they are compatible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangeValueForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation value does not conform to the expected underlying type.\n","plainTextDescription":"Aggregation value does not conform to the expected underlying type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkPropertyMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property could not be mapped to a Marketplace installation.","plainTextDescription":"The given property could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinitionOnInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.\n","plainTextDescription":"Derived property definition on an interface-typed object set was invalid due to shape of query or type\nchecking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested properties are not found on the object type.","plainTextDescription":"The requested properties are not found on the object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionInvalidInput"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsReadOnlyEntity"},"errorType":"INVALID_ARGUMENT","parameters":{"entityTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action request performs edits on a type that is read-only or does not allow edits.","plainTextDescription":"The given action request performs edits on a type that is read-only or does not allow edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadPropertyNotBackedByMediaSetView"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.\n","plainTextDescription":"The property is not backed by any media set view datasource and cannot accept media uploads. Add a media set\nview datasource that includes this property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidVectorDimension"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"providedSize":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","plainTextDescription":"The dimensions of the provided vector don't match the dimensions of the embedding model being queried.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortOrder"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortOrder":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.\n","plainTextDescription":"The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort\norder can also be omitted, and defaults to 'asc'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrdering"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.\n","plainTextDescription":"Aggregation ordering can only be applied to metrics with exactly one groupBy clause.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotResolvable"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"strategy":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.\n","plainTextDescription":"A Cipher Channel could not be resolved for encryption under the requested\ncipherChannelStrategy. Depending on the strategy, this means the object has no existing\nencrypted value and/or the property has no default Cipher Channel configured.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkIdsDoNotExistInActionType"},"errorType":"INVALID_ARGUMENT","parameters":{"unknownUniqueIdentifierLinkIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"UniqueIdentifierLinkId"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.\n","plainTextDescription":"One or more unique identifier link IDs specified in apply action overrides could not be found\nin the ActionType definition.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidSortType"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidSortType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","plainTextDescription":"The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Failed to find a provided property for a given object.\n","plainTextDescription":"Failed to find a provided property for a given object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRidNotFound"},"errorType":"NOT_FOUND","parameters":{"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type RID is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type RID is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFiltersCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided filters cannot be used together.","plainTextDescription":"The provided filters cannot be used together.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The object the user is attempting to create already exists.\n","plainTextDescription":"The object the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MediaUploadDestinationNotConfigured"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.\n","plainTextDescription":"The media reference property is backed by multiple media set views, and none of them are marked as the upload\ndestination for this property. Set an upload destination on exactly one of the backing media set views for\nthis property in Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiNameNotUnique"},"errorType":"INVALID_ARGUMENT","parameters":{"ontologyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","plainTextDescription":"The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotFilterable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and\n*Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked *Searchable* and *Selectable* and when it can be used.\n","plainTextDescription":"Results could not be filtered by the requested properties. Please mark the properties as Searchable and\nSelectable in the Ontology Manager to be able to filter on those properties. There may be a short delay\nbetween the time a property is marked Searchable and Selectable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.\n","plainTextDescription":"There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this\nAPI for a given request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetNotFound"},"errorType":"NOT_FOUND","parameters":{"objectSetRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectSetRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object set is not found, or the client token does not have access to it.","plainTextDescription":"The requested object set is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DuplicateOrderBy"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested sort order includes duplicate properties.","plainTextDescription":"The requested sort order includes duplicate properties.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionEncounteredUserFacingError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored function failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParametersNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"unknownParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"configuredParameterIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field\nto see which ones are available.\n","plainTextDescription":"The provided parameter ID was not found for the action. Please look at the configuredParameterIds field\nto see which ones are available.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkTypeId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The link type is not found, or the user does not have access to it.","plainTextDescription":"The link type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingInterfaceProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property types are not present on every object type.","plainTextDescription":"The requested interface property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"HighScaleComputationNotEnabled"},"errorType":"TIMEOUT","parameters":{},"documentation":{"description":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","plainTextDescription":"High-scale compute was required for this Ontology query but is not enabled on this enrollment.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"valueType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value type is not found, or the user does not have access to it.","plainTextDescription":"The value type is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidUserId"},"errorType":"INVALID_ARGUMENT","parameters":{"userId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a user id must be a UUID.","plainTextDescription":"The provided value for a user id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationNestedObjectSetSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"objectsCount":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"objectsLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.\n","plainTextDescription":"A nested object set within the aggregation exceeded the allowed limit.\nThis can be fixed by aggregating over fewer objects, such as by applying a filter.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMemoryExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"memoryUsedBytes":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"memoryLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n- If you are using multiple `groupBy` clauses, try reducing the number of clauses.\n- If you are using a `groupBy` clause with a high cardinality property, try filtering the data first\n to reduce the number of groups.\n","plainTextDescription":"The amount of memory used in the request exceeded the limit. This can typically be fixed by\nadjusting your query to reduce the number of groups created by your aggregation. For instance:\n\nIf you are using multiple groupBy clauses, try reducing the number of clauses.\nIf you are using a groupBy clause with a high cardinality property, try filtering the data first\nto reduce the number of groups.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyFiltersNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for\na list of supported property filters.\n","plainTextDescription":"At least one of the requested property filters are not supported. See the documentation of PropertyFilter for\na list of supported property filters.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkAlreadyExists"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The link the user is attempting to create already exists.\n","plainTextDescription":"The link the user is attempting to create already exists.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionFailed"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationDepthExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"depth":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"depthLimit":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.\n","plainTextDescription":"The aggregation request contains too many levels of nested groupings. This can be fixed by reducing the\nnumber of nested groupings in your request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidRangeQuery"},"errorType":"INVALID_ARGUMENT","parameters":{"lt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than","plainTextDescription":"Less than","example":[]}},"gt":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than","plainTextDescription":"Greater than","example":[]}},"lte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Less than or equal","plainTextDescription":"Less than or equal","example":[]}},"gte":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"any","any":{}}}}},"safety":"UNSAFE","documentation":{"description":"Greater than or equal","plainTextDescription":"Greater than or equal","example":[]}},"field":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The specified query range filter is invalid.\n","plainTextDescription":"The specified query range filter is invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDerivedPropertyDefinition"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"derivedProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DerivedPropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Derived property definition was invalid due to shape of query or type checking.","plainTextDescription":"Derived property definition was invalid due to shape of query or type checking.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationAccuracyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.\n","plainTextDescription":"The given aggregation cannot be performed with the requested accuracy.\nTry allowing approximate results or adjust your aggregation request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ViewObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.\n","plainTextDescription":"The provided token does not have permission to view any data sources backing this object type. Ensure the object\ntype has backing data sources configured and visible.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AggregationMetricNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"metricType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.\n","plainTextDescription":"The requested aggregation metric is not supported by the storage backend.\nConsider migrating queried object types to Object Storage V2. See\nhttps://www.palantir.com/docs/foundry/object-backend/osv1-osv2-migration\nfor more details.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryNotFound"},"errorType":"NOT_FOUND","parameters":{"query":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query is not found, or the user does not have access to it.","plainTextDescription":"The query is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by interface property type.\n","plainTextDescription":"Range group by is not supported by interface property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DistinctEnumValuesExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"maxDistinctValues":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","plainTextDescription":"An enum time series contained too many distinct enum values. Check that the time series sync is using the correct value column.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingValueTypeReference"},"errorType":"INVALID_ARGUMENT","parameters":{"referencedRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","plainTextDescription":"This struct value type references another value type which either doesn't exist, or the user doesn't have access to.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `PropertyValue` for details on\nhow properties are represented.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of PropertyValue for details on\nhow properties are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionValidationFailed"},"errorType":"INVALID_ARGUMENT","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The validation failed for the given action parameters. Please use the `validateAction` endpoint for more\ndetails.\n","plainTextDescription":"The validation failed for the given action parameters. Please use the validateAction endpoint for more\ndetails.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSortable"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and\n*Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay\nbetween the time a property is set to *Searchable* and *Sortable* and when it can be used.\n","plainTextDescription":"Results could not be ordered by the requested properties. Please mark the properties as Searchable and\nSortable in the Ontology Manager to enable their use in orderBy parameters. There may be a short delay\nbetween the time a property is set to Searchable and Sortable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultipleGroupByOnFieldNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"duplicateFields":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Aggregation cannot group by on the same field multiple times.\n","plainTextDescription":"Aggregation cannot group by on the same field multiple times.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LinkedObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"linkType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"LinkTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"linkedObjectPrimaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The linked object with the given primary key is not found, or the user does not have access to it.","plainTextDescription":"The linked object with the given primary key is not found, or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypesSearchNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"valueType":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The search on the property types are not supported. See the `Search Objects` documentation for\na list of supported search queries on different property types.\n","plainTextDescription":"The search on the property types are not supported. See the Search Objects documentation for\na list of supported search queries on different property types.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryOutputValue"},"errorType":"INVALID_ARGUMENT","parameters":{"outputDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"outputValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.\n","plainTextDescription":"The value of the query's output is invalid. This may be because the return value did not match the specified\noutput type or constraints.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyNotFoundOnObject"},"errorType":"INVALID_ARGUMENT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectRid"}}},"safety":"SAFE","documentation":{"example":[]}},"objectPropertyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","plainTextDescription":"Could not find the given property on the object. The user may not have permissions to see this property or it may be configured incorrectly.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterBaseType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterDataType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyDataType"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"interfaceLinkTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceLinkTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceLinkTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface link type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface link type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectChanged"},"errorType":"CONFLICT","parameters":{"primaryKey":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An object used by this `Action` was changed by someone else while the `Action` was running.\n","plainTextDescription":"An object used by this Action was changed by someone else while the Action was running.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnsupportedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set is not supported.","plainTextDescription":"The requested object set is not supported.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryVersionNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The query could not be found at the provided version.\n","plainTextDescription":"The query could not be found at the provided version.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested shared property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditedPropertiesNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.\n","plainTextDescription":"Actions attempted to edit properties that could not be found on the object type.\nPlease contact the Ontology administrator to resolve this issue.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyNotFound"},"errorType":"NOT_FOUND","parameters":{"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface property was not found on the interface type.","plainTextDescription":"The requested interface property was not found on the interface type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncingObjectTypes"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more requested object types have been changed in the **Ontology Manager** and changes are currently being\napplied. Wait a few seconds and try again.\n","plainTextDescription":"One or more requested object types have been changed in the Ontology Manager and changes are currently being\napplied. Wait a few seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRange"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation range should include one lt or lte and one gt or gte.\n","plainTextDescription":"Aggregation range should include one lt or lte and one gt or gte.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"FunctionExecutionTimedOut"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.\n","plainTextDescription":"The parameter object reference or parameter default value is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryMemoryExceededLimit"},"errorType":"TIMEOUT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Memory limits were exceeded for the `Query` execution.\n","plainTextDescription":"Memory limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidApplyActionOptionCombination"},"errorType":"INVALID_ARGUMENT","parameters":{"invalidCombination":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ApplyActionRequestOptions"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given options are individually valid but cannot be used in the given combination.","plainTextDescription":"The given options are individually valid but cannot be used in the given combination.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryTimeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Time limits were exceeded for the `Query` execution.\n","plainTextDescription":"Time limits were exceeded for the Query execution.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ConsistentSnapshotError"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.\n","plainTextDescription":"An Ontology objects read failed because the Ontology snapshot snapshot used for consistent reads became\nstale. Retrying the request typically resolves this.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CompositePrimaryKeyNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"Primary keys consisting of multiple properties are not supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"RateLimitReached"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.\n","plainTextDescription":"Unable to decrypt this CipherText because the available rate limits in Cipher licenses were reached.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SimilarityThresholdOutOfRange"},"errorType":"INVALID_ARGUMENT","parameters":{"providedThreshold":{"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","plainTextDescription":"The value of the similarity threshold must be in the range 0 <= threshold <= 1.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyDefinitionOutOfSync"},"errorType":"CONFLICT","parameters":{"objectTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The ontology definition is temporarily out of sync. The indexed definition does not yet \nreflect the latest saved definition for this type. This is typically a transient condition that \nresolves as indexing completes.\n","plainTextDescription":"The ontology definition is temporarily out of sync. The indexed definition does not yet\nreflect the latest saved definition for this type. This is typically a transient condition that\nresolves as indexing completes.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyFilterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"expectedType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"propertyFilterValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FilterValue"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\n`isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type.\n","plainTextDescription":"The value of the given property filter is invalid. For instance, 2 is an invalid value for\nisNull in properties.address.isNull=2 because the isNull filter expects a value of boolean type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryEncounteredUserFacingError"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.\n","plainTextDescription":"The authored Query failed to execute because of a user induced error. The message argument\nis meant to be displayed to the user.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionEditsNotSupportedWithMarketplace"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Returning action edits is not supported when using marketplace bindings.\n","plainTextDescription":"Returning action edits is not supported when using marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyBaseTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested property is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"IncompatibleNestedObjectSet"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.\n","plainTextDescription":"A wrapper object set type is incompatible with one or more of the nested object set types.\nFor example, an interfaceLinkSearchAround object set wrapping a non-interface object set.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypesNotSynced"},"errorType":"CONFLICT","parameters":{"objectTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.\n","plainTextDescription":"One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology\nAdministrator to re-index the object type(s) in Ontology Management Application.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UnauthorizedCipherOperation"},"errorType":"PERMISSION_DENIED","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided token does not have permission to take a specific Cipher operation.\n","plainTextDescription":"The provided token does not have permission to take a specific Cipher operation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidContentLength"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"A `Content-Length` header is required for all uploads, but was missing or invalid.","plainTextDescription":"A Content-Length header is required for all uploads, but was missing or invalid.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkQueryMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"queryType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given query could not be mapped to a Marketplace installation.","plainTextDescription":"The given query could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypesNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface types were not found, or the client token does not have access to it.","plainTextDescription":"The requested interface types were not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"rid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested interface type is not found, or the client token does not have access to it.","plainTextDescription":"The requested interface type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertiesNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"missingSharedProperties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested shared property types are not present on every object type.","plainTextDescription":"The requested shared property types are not present on every object type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationOrderingWithNullValues"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.\n","plainTextDescription":"Aggregation ordering cannot be applied for groupBy clauses that allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentSizeExceededLimit"},"errorType":"INVALID_ARGUMENT","parameters":{"fileSizeBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"fileLimitBytes":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.\n","plainTextDescription":"The file is too large to be uploaded as an attachment.\nThe maximum attachment size is 200MB.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectsModifiedConcurrently"},"errorType":"CONFLICT","parameters":{"functionRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.\n","plainTextDescription":"The provided objects are being modified concurrently and the operation would result in a conflict.\nThe client should retry the request later.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MultiplePropertyValuesNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyFilter":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyFilter"}}},"safety":"SAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.\n","plainTextDescription":"One of the requested property filters does not support multiple values. Please include only a single value for\nit.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeError"},"errorType":"INVALID_ARGUMENT","parameters":{"functionRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionRid"}}},"safety":"SAFE","documentation":{"example":[]}},"functionVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"FunctionVersion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"message":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"stacktrace":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameters":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryRuntimeErrorParameter"}}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The authored `Query` failed to execute because of a runtime error.\n","plainTextDescription":"The authored Query failed to execute because of a runtime error.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceActionMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"actionType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ActionTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given action could not be mapped to a Marketplace installation.","plainTextDescription":"The given action could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyExactMatchingNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that does not support exact matching is used in a setting that requires exact matching.","plainTextDescription":"A property that does not support exact matching is used in a setting that requires exact matching.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeDoesNotSupportNearestNeighbors"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","plainTextDescription":"The provided propertyIdentifier is not configured with an embedding model in the ontology.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"EditObjectPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to edit this `ObjectType`.\n","plainTextDescription":"The user does not have permission to edit this ObjectType.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesNotSearchable"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiNames":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Search is not enabled on the specified properties. Please mark the properties as *Searchable*\nin the **Ontology Manager** to enable search on them. There may be a short delay\nbetween the time a property is marked *Searchable* and when it can be used.\n","plainTextDescription":"Search is not enabled on the specified properties. Please mark the properties as Searchable\nin the Ontology Manager to enable search on them. There may be a short delay\nbetween the time a property is marked Searchable and when it can be used.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"NotCipherFormatted"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHER::::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher is not formatted correctly.\nIt may already be a plaintext value and not require decryption.\nEnsure it is correctly formatted (CIPHERCIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentNotFound"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested attachment is not found, or the client token does not have access to it. \nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.\n","plainTextDescription":"The requested attachment is not found, or the client token does not have access to it.\nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ActionContainsDuplicateEdits"},"errorType":"CONFLICT","parameters":{},"documentation":{"description":"The given action request has multiple edits on the same object.","plainTextDescription":"The given action request has multiple edits on the same object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectTypeRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type is not found, or the client token does not have access to it.","plainTextDescription":"The requested object type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidTransactionEditPropertyValue"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyApiName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyValue":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given property is invalid. See the documentation of `DataValue` for details on\nhow properties are represented for transaction edits.\n","plainTextDescription":"The value of the given property is invalid. See the documentation of DataValue for details on\nhow properties are represented for transaction edits.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectNotFound"},"errorType":"NOT_FOUND","parameters":{"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PrimaryKeyValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object is not found, or the client token does not have access to it.","plainTextDescription":"The requested object is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"CipherChannelNotFound"},"errorType":"NOT_FOUND","parameters":{"cipherChannel":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.\n","plainTextDescription":"The Cipher Channel was not found.\nIt either does not exist, or you do not have permission to see it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidOrderType"},"errorType":"INVALID_ARGUMENT","parameters":{"orderType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SearchOrderByType"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"This query type does not support the provided order type","plainTextDescription":"This query type does not support the provided order type","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParentAttachmentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"The user does not have permission to parent attachments.\n","plainTextDescription":"The user does not have permission to parent attachments.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiNameNotFound"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the **Ontology Manager**.\n","plainTextDescription":"A property that was required to have an API name, such as a primary key, is missing one. You can set an API\nname for it using the Ontology Manager.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"TooManyNearestNeighborsRequested"},"errorType":"INVALID_ARGUMENT","parameters":{"requestedNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},"maxNumNeighbors":{"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","plainTextDescription":"The value of numNeighbors must be in the range 1 <= numNeighbors <= 500.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InterfaceBasedObjectSetNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The requested object set type is not supported for interface-based object sets.","plainTextDescription":"The requested object set type is not supported for interface-based object sets.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyTypeForInterface"},"errorType":"INVALID_ARGUMENT","parameters":{"interfaceProperty":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfacePropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"interfaceType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"InterfaceTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid interface property type for duration groupBy.\n","plainTextDescription":"Invalid interface property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"BranchNotSupportedWithMarketplaceQuery"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The branch parameter is not supported when executing queries with marketplace bindings.\n","plainTextDescription":"The branch parameter is not supported when executing queries with marketplace bindings.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"DefaultAndNullGroupsNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"Exact match groupBy clause cannot specify a default value and allow null values.\n","plainTextDescription":"Exact match groupBy clause cannot specify a default value and allow null values.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"UndecryptableValue"},"errorType":"INVALID_ARGUMENT","parameters":{"value":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER:::::CIPHER).\n","plainTextDescription":"The value intended for decryption with Cipher cannot be decrypted.\nEnsure it is correctly formatted (CIPHER::CIPHER).","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ObjectEditMissingPrimaryKey"},"errorType":"INVALID_ARGUMENT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"primaryKey":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.\n","plainTextDescription":"An add object edit in the transaction did not include the object's primary key property. The primary key\nproperty must be provided when creating an object.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"ParameterTypeNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.\n","plainTextDescription":"The type of the requested parameter is not currently supported by this API. If you need support for this,\nplease reach out to Palantir Support.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidGroupId"},"errorType":"INVALID_ARGUMENT","parameters":{"groupId":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided value for a group id must be a UUID.","plainTextDescription":"The provided value for a group id must be a UUID.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertiesHaveDifferentIds"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SharedPropertyTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Properties used in ordering must have the same ids.\n","plainTextDescription":"Properties used in ordering must have the same ids.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidAggregationRangePropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Range group by is not supported by property type.\n","plainTextDescription":"Range group by is not supported by property type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidFields"},"errorType":"INVALID_ARGUMENT","parameters":{"properties":{"type":{"type":"list","list":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given field does not match the expected pattern. For example, an Ontology object property `id`\nshould be written `properties.id`.\n","plainTextDescription":"The value of the given field does not match the expected pattern. For example, an Ontology object property id\nshould be written properties.id.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologyNotFound"},"errorType":"NOT_FOUND","parameters":{"ontologyRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"apiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"OntologyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested Ontology is not found, or the client token does not have access to it.","plainTextDescription":"The requested Ontology is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidQueryParameterValue"},"errorType":"INVALID_ARGUMENT","parameters":{"parameterDataType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"QueryDataType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parameterValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"DataValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The value of the given parameter is invalid. See the documentation of `DataValue` for details on\nhow parameters are represented.\n","plainTextDescription":"The value of the given parameter is invalid. See the documentation of DataValue for details on\nhow parameters are represented.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceSdkObjectMappingNotFound"},"errorType":"NOT_FOUND","parameters":{"localObjectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"sdkPackageRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageRid"}}},"safety":"SAFE","documentation":{"example":[]}},"sdkVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkVersion"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The given object could not be mapped to a Marketplace installation.","plainTextDescription":"The given object could not be mapped to a Marketplace installation.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"OntologySyncing"},"errorType":"CONFLICT","parameters":{"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a\nfew seconds and try again.\n","plainTextDescription":"The requested object type has been changed in the Ontology Manager and changes are currently being applied. Wait a\nfew seconds and try again.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"PropertyTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"objectTypeApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyApiName":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The requested property type is not found, or the client token does not have access to it.","plainTextDescription":"The requested property type is not found, or the client token does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given property type is not of the expected type.\n","plainTextDescription":"The given property type is not of the expected type.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MarketplaceInstallationNotFound"},"errorType":"NOT_FOUND","parameters":{"artifactRepository":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ArtifactRepositoryRid"}}},"safety":"SAFE","documentation":{"example":[]}},"packageName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"SdkPackageName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The given marketplace installation could not be found or the user does not have access to it.\n","plainTextDescription":"The given marketplace installation could not be found or the user does not have access to it.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"InvalidDurationGroupByPropertyType"},"errorType":"INVALID_ARGUMENT","parameters":{"property":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"PropertyApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"objectType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ObjectTypeApiName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"propertyBaseType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Invalid property type for duration groupBy.\n","plainTextDescription":"Invalid property type for duration groupBy.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"MissingParameter"},"errorType":"INVALID_ARGUMENT","parameters":{"parameters":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"ParameterId"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Required parameters are missing. Please look at the `parameters` field to see which required parameters are\nmissing from the request.\n","plainTextDescription":"Required parameters are missing. Please look at the parameters field to see which required parameters are\nmissing from the request.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRidAlreadyExists"},"errorType":"NOT_FOUND","parameters":{"attachmentRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Ontologies","localName":"AttachmentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided attachment RID already exists and cannot be overwritten.\n","plainTextDescription":"The provided attachment RID already exists and cannot be overwritten.","example":[]}},{"locator":{"namespaceName":"Ontologies","localName":"LoadObjectSetLinksNotSupported"},"errorType":"FAILED_PRECONDITION","parameters":{},"documentation":{"description":"Bulk loading object set links is not supported by Object Storage v1.\n","plainTextDescription":"Bulk loading object set links is not supported by Object Storage v1.","example":[]}}]}; diff --git a/packages/docs-spec-platform/src/generated/namespaces/PackV2.ts b/packages/docs-spec-platform/src/generated/namespaces/PackV2.ts index 65c214ac5..8bd8676f5 100644 --- a/packages/docs-spec-platform/src/generated/namespaces/PackV2.ts +++ b/packages/docs-spec-platform/src/generated/namespaces/PackV2.ts @@ -17,4 +17,4 @@ import type { Namespace } from "../../ir/Namespace.js"; // dprint-ignore -export const PackV2: Namespace = {"name":"Pack","version":"v2","resources":[{"singleton":false,"documentation":{"description":"A Document Type represents the user-defined schema for application state.","plainTextDescription":"A Document Type represents the user-defined schema for application state.","example":[]},"component":{"namespaceName":"Pack","localName":"DocumentType"},"idPropertyName":"rid","pluralName":"DocumentTypes","pathSegment":"documentTypes","operations":[{"name":"createDocumentType","verb":"create","documentation":{"description":"Creates a PACK Document Type with the provided schema and metadata.\n","plainTextDescription":"Creates a PACK Document Type with the provided schema and metadata.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"Example Document Type","fileSystemType":"ARTIFACTS"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"The created DocumentType","plainTextDescription":"The created DocumentType","example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAlreadyExists"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"This Document Type Name already exists for the given ontology.\n","plainTextDescription":"This Document Type Name already exists for the given ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the DocumentType.","plainTextDescription":"Could not create the DocumentType.","example":[]}}]},{"name":"getDocumentType","verb":"get","documentation":{"description":"Get the DocumentType with the specified rid.","plainTextDescription":"Get the DocumentType with the specified rid.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/{documentTypeRid}","httpMethod":"GET","parameters":[{"name":"documentTypeRid","documentation":{"example":["ri.backpack..document-type.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":["ri.backpack..document-type.12345"]}}},"documentation":{"description":"The given DocumentType could not be found.","plainTextDescription":"The given DocumentType could not be found.","example":[]}}]},{"name":"loadByNameDocumentTypes","verb":"loadByName","documentation":{"description":"Loads the PACK Document Type's metadata by the provided Document Type Name.\n","plainTextDescription":"Loads the PACK Document Type's metadata by the provided Document Type Name.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/loadByName","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not loadByName the DocumentType.","plainTextDescription":"Could not loadByName the DocumentType.","example":[]}}]},{"name":"createFirstPartyDocumentType","verb":"createFirstParty","documentation":{"description":"Creates a first-party Document Type with the given schema in the specified ontology.\nThis is intended for use by internal Palantir workflows. For external application developers,\ndocument types should be created through the Create Document Type operation.\n","plainTextDescription":"Creates a first-party Document Type with the given schema in the specified ontology.\nThis is intended for use by internal Palantir workflows. For external application developers,\ndocument types should be created through the Create Document Type operation.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/createFirstParty","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requestBody":{"fileSystemType":"ARTIFACTS"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAlreadyExists"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"This Document Type Name already exists for the given ontology.\n","plainTextDescription":"This Document Type Name already exists for the given ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeName"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Name is invalid. First-party document type names must follow the format\n`com.palantir.pack..`.\n","plainTextDescription":"The provided Document Type Name is invalid. First-party document type names must follow the format\ncom.palantir.pack...","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeVersion"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Version is invalid. The version must be a positive integer.\n","plainTextDescription":"The provided Document Type Version is invalid. The version must be a positive integer.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createFirstParty the DocumentType.","plainTextDescription":"Could not createFirstParty the DocumentType.","example":[]}}]},{"name":"updateSchemaDocumentType","verb":"updateSchema","documentation":{"description":"Updates the schema of a PACK Document Type. The new schema version must be strictly\ngreater than the current version. Schema validation is performed to ensure backwards\ncompatibility unless forceOverwrite is set to true.\n","plainTextDescription":"Updates the schema of a PACK Document Type. The new schema version must be strictly\ngreater than the current version. Schema validation is performed to ensure backwards\ncompatibility unless forceOverwrite is set to true.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/updateSchema","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeVersion"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Version is invalid. The version must be a positive integer.\n","plainTextDescription":"The provided Document Type Version is invalid. The version must be a positive integer.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaUpdateConflict"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.\n","plainTextDescription":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not updateSchema the DocumentType.","plainTextDescription":"Could not updateSchema the DocumentType.","example":[]}}]},{"name":"getOperationalVersionDocumentType","verb":"getOperationalVersion","documentation":{"description":"Returns the computed operational version for a document type. The operational version is the highest\nschema version that all deployed asset tracks can support, used for document compatibility checks.\n","plainTextDescription":"Returns the computed operational version for a document type. The operational version is the highest\nschema version that all deployed asset tracks can support, used for document compatibility checks.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/getOperationalVersion","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not getOperationalVersion the DocumentType.","plainTextDescription":"Could not getOperationalVersion the DocumentType.","example":[]}}]}]},{"singleton":false,"documentation":{"description":"A Document represents an instance of application state.","plainTextDescription":"A Document represents an instance of application state.","example":[]},"component":{"namespaceName":"Pack","localName":"Document"},"idPropertyName":"id","pluralName":"Documents","pathSegment":"documents","operations":[{"name":"createDocument","verb":"create","documentation":{"description":"Deprecated: use `createV2` instead, which takes the document parent (namespace or folder)\ndirectly on the request.\n","plainTextDescription":"Deprecated: use createV2 instead, which takes the document parent (namespace or folder)\ndirectly on the request.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","ontologyRid":"ri.ontology.main.ontology.12345","name":"Example Document","description":"Example document description.","documentTypeName":"Example Document Type"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"The created Document","plainTextDescription":"The created Document","example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationMissingParentFolder"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass-backed documents require a parent folder upon creation.\n","plainTextDescription":"Compass-backed documents require a parent folder upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationWithDiscretionarySecurityNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.\n","plainTextDescription":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the Document.","plainTextDescription":"Could not create the Document.","example":[]}}]},{"name":"deleteDocument","verb":"delete","documentation":{"description":"Delete the Document with the specified id.","plainTextDescription":"Delete the Document with the specified id.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataDelete"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}","httpMethod":"DELETE","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"CannotDeleteAutosavedDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Autosaved documents cannot be deleted.\n","plainTextDescription":"Autosaved documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CannotDeleteHiddenDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Hidden documents cannot be deleted.\n","plainTextDescription":"Hidden documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DeleteDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not delete the Document.","plainTextDescription":"Could not delete the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}}]},{"name":"getDocument","verb":"get","documentation":{"description":"Get the Document with the specified id.","plainTextDescription":"Get the Document with the specified id.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}","httpMethod":"GET","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}}]},{"name":"searchDocuments","verb":"search","documentation":{"description":"Loads all PACK Documents visible to the user of the provided Document Type Name. If a search request\nis provided, filters and sorts the results based on the user's query, sort, and pagination options.\nWhen an ontology RID is provided on the request, results are scoped to that ontology; otherwise the\ndocument type name is searched across all ontologies.\n","plainTextDescription":"Loads all PACK Documents visible to the user of the provided Document Type Name. If a search request\nis provided, filters and sorts the results based on the user's query, sort, and pagination options.\nWhen an ontology RID is provided on the request, results are scoped to that ontology; otherwise the\ndocument type name is searched across all ontologies.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/search","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requestBody":{"query":{"documentName":"MyDocument"},"orderBy":{"field":"NAME","direction":"ASC"},"pageSize":10}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"data":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSearchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not search the Document.","plainTextDescription":"Could not search the Document.","example":[]}}]},{"name":"updateDocument","verb":"update","documentation":{"description":"Updates the metadata (name, description, and/or security) of a PACK Document.\n","plainTextDescription":"Updates the metadata (name, description, and/or security) of a PACK Document.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}/update","httpMethod":"POST","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentNotSupported"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to update this document, or the document does not exist.\n","plainTextDescription":"The user does not have permission to update this document, or the document does not exist.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not update the Document.","plainTextDescription":"Could not update the Document.","example":[]}}]},{"name":"resolveApplicationDocument","verb":"resolveApplication","documentation":{"description":"Resolves a PACK Document to the application that owns its Document Type. Returns the owning\napplication id from the document type metadata, or empty if none is configured.\n","plainTextDescription":"Resolves a PACK Document to the application that owns its Document Type. Returns the owning\napplication id from the document type metadata, or empty if none is configured.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}/resolveApplication","httpMethod":"GET","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ResolveDocumentApplicationResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"ResolveApplicationDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not resolveApplication the Document.","plainTextDescription":"Could not resolveApplication the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}}]},{"name":"createDocumentAsChild","verb":"createChild","documentation":{"description":"Creates a PACK Document as a hidden child of the given folder or document, inheriting its security and staying\nin sync as the parent's security changes.\n","plainTextDescription":"Creates a PACK Document as a hidden child of the given folder or document, inheriting its security and staying\nin sync as the parent's security changes.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/createChild","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotCompassBacked"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.\n","plainTextDescription":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidChildDocumentParent"},"errorType":"INVALID_ARGUMENT","parameters":{"parentResourceRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A child document's parent must be a folder or another document.\n","plainTextDescription":"A child document's parent must be a folder or another document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createChild the Document.","plainTextDescription":"Could not createChild the Document.","example":[]}}]},{"name":"createDocumentWithMatchingSecurity","verb":"createMatchingSecurity","documentation":{"description":"Creates a PACK Document that copies the directly-applied security markings of a source Document. The\nnew Document's security is independent of the source's afterward.\n","plainTextDescription":"Creates a PACK Document that copies the directly-applied security markings of a source Document. The\nnew Document's security is independent of the source's afterward.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/createMatchingSecurity","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requestBody":{"destinationFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotCompassBacked"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.\n","plainTextDescription":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createMatchingSecurity the Document.","plainTextDescription":"Could not createMatchingSecurity the Document.","example":[]}}]},{"name":"createDocumentV2","verb":"createV2","documentation":{"description":"Creates a PACK Document and returns it.\n","plainTextDescription":"Creates a PACK Document and returns it.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/createV2","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2Request"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ArtifactDocumentCreationMissingNamespace"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Artifact-backed documents require a namespace upon creation.\n","plainTextDescription":"Artifact-backed documents require a namespace upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationMissingParentFolder"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass-backed documents require a parent folder upon creation.\n","plainTextDescription":"Compass-backed documents require a parent folder upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationWithDiscretionarySecurityNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.\n","plainTextDescription":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2PermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createV2 the Document.","plainTextDescription":"Could not createV2 the Document.","example":[]}}]}]}],"components":[{"locator":{"namespaceName":"Pack","localName":"ActivityCollaborativeUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"activityDeleted":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ActivityDeleted"}}}},"activityCreated":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ActivityCreated"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event broadcast to all clients after being applied on server.\n","plainTextDescription":"Activity event broadcast to all clients after being applied on server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ActivityCreated"},"type":{"type":"object","object":{"properties":{"activityEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ActivityEvent"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The event that gets published to PACK channels to update a users activity feed as new events\nare added to a particular resource.\n","plainTextDescription":"The event that gets published to PACK channels to update a users activity feed as new events\nare added to a particular resource.","example":[{"activityEvent":{"createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","createdTime":"2024-09-25T17:29:35.974Z"}}]}},{"locator":{"namespaceName":"Pack","localName":"ActivityDeleted"},"type":{"type":"object","object":{"properties":{"eventId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EventId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aggregationKey":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The event that gets published to PACK channels to update a users activity feed whenever an event\nis removed from a particular resource.\n","plainTextDescription":"The event that gets published to PACK channels to update a users activity feed whenever an event\nis removed from a particular resource.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ActivityEvent"},"type":{"type":"object","object":{"properties":{"eventId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EventId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"eventData":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EventDataUnion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"isRead":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"aggregationKey":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Producer defined key to determine how activity events should be aggregated when displayed\non the FE. If this event is not to be grouped at all, provide the same value as the eventId\nto guarantee this event will not be aggregated with any others.\n","plainTextDescription":"Producer defined key to determine how activity events should be aggregated when displayed\non the FE. If this event is not to be grouped at all, provide the same value as the eventId\nto guarantee this event will not be aggregated with any others.","example":[]}},"createdBy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedBy"}}},"safety":"SAFE","documentation":{"example":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}},"createdTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedTime"}}},"safety":"SAFE","documentation":{"example":["2024-09-25T17:29:35.974Z"]}}}}},"safety":"UNSAFE","documentation":{"description":"A single activity event associated with a particular document. The eventData union\ndiscriminant determines the type of event: platform-defined events (e.g. document create,\nrename, security changes) and custom application-defined events.\n","plainTextDescription":"A single activity event associated with a particular document. The eventData union\ndiscriminant determines the type of event: platform-defined events (e.g. document create,\nrename, security changes) and custom application-defined events.","example":[{"createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","createdTime":"2024-09-25T17:29:35.974Z"}]}},{"locator":{"namespaceName":"Pack","localName":"AllPrincipal"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An empty type representing all users in the system. Useful for expressing\noperations that should be allowed by what is typically the 'Everyone' group,\nor for expressing that anyone who satisfies Mandatory security is granted\ndiscretionary access.\n","plainTextDescription":"An empty type representing all users in the system. Useful for expressing\noperations that should be allowed by what is typically the 'Everyone' group,\nor for expressing that anyone who satisfies Mandatory security is granted\ndiscretionary access.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ClientId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"},"type":{"type":"object","object":{"properties":{"minVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}},"maxVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"PACK clients may support a range of document type schema versions. This allows for schema upgrades while\nmaintaining cross-client collaboration compatibility.\n","plainTextDescription":"PACK clients may support a range of document type schema versions. This allows for schema upgrades while\nmaintaining cross-client collaboration compatibility.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateChildDocumentRequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parentResourceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"ResourceRid"}}},"safety":"UNSAFE","documentation":{"description":"The folder or document the new Document is created under and inherits security from.\nMust be a folder or another document; any other resource type is rejected with \n`InvalidChildDocumentParent`.\n","plainTextDescription":"The folder or document the new Document is created under and inherits security from.\nMust be a folder or another document; any other resource type is rejected with\nInvalidChildDocumentParent.","example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The Document Type to instantiate, resolved by name in the namespace of the parent resource.\n","plainTextDescription":"The Document Type to instantiate, resolved by name in the namespace of the parent resource.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a Document as a hidden child of a hidden child of a folder or document. The Document inherits its\nsecurity from the parent resource and stays in sync as the parent's security changes.\n","plainTextDescription":"Request to create a Document as a hidden child of a hidden child of a folder or document. The Document inherits its\nsecurity from the parent resource and stays in sync as the parent's security changes.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateChildDocumentRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a child document.","plainTextDescription":"The request to create a child document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentMatchingSecurityRequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceDocumentRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"description":"The Document whose directly-applied markings are copied onto the new Document.","plainTextDescription":"The Document whose directly-applied markings are copied onto the new Document.","example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The Document Type to instantiate, resolved by name in the namespace of the new Document's parent -\nthe destinationFolderRid when provided, otherwise the source Document's parent.\n","plainTextDescription":"The Document Type to instantiate, resolved by name in the namespace of the new Document's parent -\nthe destinationFolderRid when provided, otherwise the source Document's parent.","example":[]}},"destinationFolderRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}}}},"safety":"SAFE","documentation":{"description":"The folder to create the new Document in. If absent, the new Document is created under the same\nparent as the source Document.\n","plainTextDescription":"The folder to create the new Document in. If absent, the new Document is created under the same\nparent as the source Document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a Document whose security is a one-time copy of a source Document's directly-applied\nmarkings. The new Document's security is independent of the source's afterward.\n","plainTextDescription":"Request to create a Document whose security is a one-time copy of a source Document's directly-applied\nmarkings. The new Document's security is independent of the source's afterward.","example":[{"destinationFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentRequest"},"type":{"type":"object","object":{"properties":{"parentFolderRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}}}},"safety":"SAFE","documentation":{"description":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.\n","plainTextDescription":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.","example":[]}},"security":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}},"safety":"UNSAFE","documentation":{"example":[]}},"ontologyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentOntologyRid"}}},"safety":"SAFE","documentation":{"example":["ri.ontology.main.ontology.12345"]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document"]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":["Example document description."]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}}}}},"safety":"UNSAFE","documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","ontologyRid":"ri.ontology.main.ontology.12345","name":"Example Document","description":"Example document description.","documentTypeName":"Example Document Type"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"parentFolderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"description":"The RID of the folder to create this document type in.\n","plainTextDescription":"The RID of the folder to create this document type in.","example":[]}},"schema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}},"safety":"UNSAFE","documentation":{"description":"The user-defined schema for this document type.","plainTextDescription":"The user-defined schema for this document type.","example":[]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type for this document type. Defaults to ARTIFACTS if not specified.\n","plainTextDescription":"The file system type for this document type. Defaults to ARTIFACTS if not specified.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"Example Document Type","fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2Request"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2RequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a document.","plainTextDescription":"The request to create a document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2RequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the Document Type to instantiate.","plainTextDescription":"The name of the Document Type to instantiate.","example":[]}},"security":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}},"safety":"SAFE","documentation":{"description":"The Gatekeeper parent the new Document is created under.\n","plainTextDescription":"The Gatekeeper parent the new Document is created under.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a PACK Document.","plainTextDescription":"Request to create a PACK Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentMatchingSecurityRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a document matching the security of a source document.","plainTextDescription":"The request to create a document matching the security of a source document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"requestBody":{"destinationFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}}]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a first-party document type.","plainTextDescription":"The request to create a first-party document type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"requestBody":{"fileSystemType":"ARTIFACTS"}}]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The fully qualified name of the document type. Must follow the format\n`com.palantir.pack..`.\n","plainTextDescription":"The fully qualified name of the document type. Must follow the format\ncom.palantir.pack...","example":[]}},"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology to create the document type in.","plainTextDescription":"The ontology to create the document type in.","example":[]}},"schema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}},"safety":"UNSAFE","documentation":{"description":"The schema for the document type.","plainTextDescription":"The schema for the document type.","example":[]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type. Defaults to ARTIFACTS if not specified.","plainTextDescription":"The file system type. Defaults to ARTIFACTS if not specified.","example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.\n","plainTextDescription":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.","example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The schema version.","plainTextDescription":"The schema version.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a first-party document type.","plainTextDescription":"Request to create a first-party document type.","example":[{"fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeResponse"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"description":"The RID of the created document type.","plainTextDescription":"The RID of the created document type.","example":[]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the created document type.","plainTextDescription":"The name of the created document type.","example":[]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type.","plainTextDescription":"The file system type.","example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The schema version.","plainTextDescription":"The schema version.","example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.\n","plainTextDescription":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response for creating a first-party document type.","plainTextDescription":"Response for creating a first-party document type.","example":[{"fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"CustomPresenceEvent"},"type":{"type":"object","object":{"properties":{"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"description":"On publish, server validates that the user ID matches the token provided.","plainTextDescription":"On publish, server validates that the user ID matches the token provided.","example":[]}},"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"eventData":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"eventType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"schemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The version of the presence event schema defining this data.","plainTextDescription":"The version of the presence event schema defining this data.","example":[]}},"isEphemeral":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Ephemeral messages are custom presence events that are not persisted. Defaults to false.\n\nThis field helps clients determine whether an event is a transient message or should be \npersisted to be fetched upon new clients joining or on reload. Ephemeral messages are processed faster\nwithout a DB write and should be used for messages that are not crucial for clients to receive on join, \ne.g. a user's cursor position on screen.\n","plainTextDescription":"Ephemeral messages are custom presence events that are not persisted. Defaults to false.\nThis field helps clients determine whether an event is a transient message or should be\npersisted to be fetched upon new clients joining or on reload. Ephemeral messages are processed faster\nwithout a DB write and should be used for messages that are not crucial for clients to receive on join,\ne.g. a user's cursor position on screen.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b"}]}},{"locator":{"namespaceName":"Pack","localName":"DeletionMethod"},"type":{"type":"enum","enum":{"values":["TRASHED","ARCHIVED","HARD_DELETED"]}},"safety":"SAFE","documentation":{"description":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.\n","plainTextDescription":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.","example":["TRASHED"]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"all":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"AllPrincipal"}}}},"groupId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalGroupId"}}}},"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalUserId"}}}}}}},"safety":"SAFE","documentation":{"description":"Union of all security principals usable within disjunctive security conditions.\n\nThese principals are used to grant additional role access beyond mandatory security.\n\nThis includes the special 'all' principal, which grants access to any users who meet mandatory\nfor a given discretionary role.\n","plainTextDescription":"Union of all security principals usable within disjunctive security conditions.\nThese principals are used to grant additional role access beyond mandatory security.\nThis includes the special 'all' principal, which grants access to any users who meet mandatory\nfor a given discretionary role.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalGroupId"},"type":{"type":"object","object":{"properties":{"groupId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GroupId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[{"groupId":"0d1fe74e-2b70-4a93-9b1a-80070637788b"}]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalUserId"},"type":{"type":"object","object":{"properties":{"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b"}]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionarySecurityPrincipalType"},"type":{"type":"enum","enum":{"values":["ALL_PRINCIPAL","USER"]}},"safety":"SAFE","documentation":{"description":"Indicates whether a discretionary security update event corresponds to all-principal\npermissions or user/group-specific permissions.\n","plainTextDescription":"Indicates whether a discretionary security update event corresponds to all-principal\npermissions or user/group-specific permissions.","example":["ALL_PRINCIPAL"]}},{"locator":{"namespaceName":"Pack","localName":"Document"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}},"ontologyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentOntologyRid"}}},"safety":"SAFE","documentation":{"example":["ri.ontology.main.ontology.12345"]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document"]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":["Example document description."]}},"parentFolderRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}}}},"safety":"SAFE","documentation":{"description":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.\n","plainTextDescription":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.","example":[]}},"security":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}},"safety":"UNSAFE","documentation":{"example":[]}},"createdBy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedBy"}}},"safety":"SAFE","documentation":{"example":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}},"createdTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedTime"}}},"safety":"SAFE","documentation":{"example":["2024-09-25T17:29:35.974Z"]}},"updatedBy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UpdatedBy"}}},"safety":"SAFE","documentation":{"example":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}},"updatedTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UpdatedTime"}}},"safety":"SAFE","documentation":{"example":["2024-09-25T17:29:35.974Z"]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentOperation"}}}}},"safety":"SAFE","documentation":{"description":"The set of operations the requesting user is permitted to perform on this document,\nderived from the document's discretionary security settings and the user's principals.\nClients can use this to determine which UI actions (e.g. edit, delete) to enable.\n","plainTextDescription":"The set of operations the requesting user is permitted to perform on this document,\nderived from the document's discretionary security settings and the user's principals.\nClients can use this to determine which UI actions (e.g. edit, delete) to enable.","example":[]}},"operationalVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The computed operational version for this document, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.\n","plainTextDescription":"The computed operational version for this document, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentActivitySubscriptionRequest"},"type":{"type":"object","object":{"properties":{"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A request from client to subscribe to a document's activity updates, \nrequired on a subscription request to /documents/{documentId}/activity.\n","plainTextDescription":"A request from client to subscribe to a document's activity updates,\nrequired on a subscription request to /documents/{documentId}/activity.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentCreateEventData"},"type":{"type":"object","object":{"properties":{"initialMandatorySecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurity"}}},"safety":"UNSAFE","documentation":{"description":"The mandatory security set on the document at creation time.","plainTextDescription":"The mandatory security set on the document at creation time.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the created document.","plainTextDescription":"The name of the created document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document is created.\n","plainTextDescription":"Activity event data emitted when a document is created.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentCustomEventData"},"type":{"type":"object","object":{"properties":{"eventType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The application-defined event type name as registered in the document schema.\nUsed to distinguish between different custom event subtypes within the custom event category.\n","plainTextDescription":"The application-defined event type name as registered in the document schema.\nUsed to distinguish between different custom event subtypes within the custom event category.","example":[]}},"data":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"The custom event payload data, structured according to the event type's schema definition.","plainTextDescription":"The custom event payload data, structured according to the event type's schema definition.","example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The version of the event schema defining this event data.\nNOTE: this field is deprecated and will be removed. Please use schemaVersion.\n","plainTextDescription":"The version of the event schema defining this event data.\nNOTE: this field is deprecated and will be removed. Please use schemaVersion.","example":[]}},"schemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The version of the event schema defining this event data.","plainTextDescription":"The version of the event schema defining this event data.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Versioned event data for custom application-defined activity events.\n","plainTextDescription":"Versioned event data for custom application-defined activity events.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDeletionUpdate"},"type":{"type":"object","object":{"properties":{"deletionMethod":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DeletionMethod"}}},"safety":"SAFE","documentation":{"description":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.\n","plainTextDescription":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Update broadcast to all clients upon document deletion. Attempting to resubscribe to this document after\ndeletion will fail with permission denied.\n","plainTextDescription":"Update broadcast to all clients upon document deletion. Attempting to resubscribe to this document after\ndeletion will fail with permission denied.","example":[{"deletionMethod":"TRASHED"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDescriptionUpdateEventData"},"type":{"type":"object","object":{"properties":{"newDescription":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The new description of the document.","plainTextDescription":"The new description of the document.","example":[]}},"isInitial":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"True if this is the first time the description is being set,\nfalse if updating an existing description.\n","plainTextDescription":"True if this is the first time the description is being set,\nfalse if updating an existing description.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document's description is updated.\n","plainTextDescription":"Activity event data emitted when a document's description is updated.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"},"type":{"type":"object","object":{"properties":{"owners":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"}}}}},"safety":"SAFE","documentation":{"description":"A user must match at least one of these principals to be granted\nownership of the Document. This field is required to be non-empty.\n\nThe own operation is required to change Document security and to delete Documents.\n\nIf the creator of the Document is not included in \"owners\", they will not\nbe able to delete or change the Document's security.\n","plainTextDescription":"A user must match at least one of these principals to be granted\nownership of the Document. This field is required to be non-empty.\nThe own operation is required to change Document security and to delete Documents.\nIf the creator of the Document is not included in \"owners\", they will not\nbe able to delete or change the Document's security.","example":[]}},"editors":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"}}}}},"safety":"SAFE","documentation":{"description":"A user must match at least one of these principals, or one of the\nprincipals in the owners to be granted able to edit the Document.\n\nThe edit operation is required to perform any kind of edit to a Document.\n","plainTextDescription":"A user must match at least one of these principals, or one of the\nprincipals in the owners to be granted able to edit the Document.\nThe edit operation is required to perform any kind of edit to a Document.","example":[]}},"viewers":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"}}}}},"safety":"SAFE","documentation":{"description":"A user must match at least one of these principals, or one of the\nprincipals in the owners or editors to be able to view the Document.\n\nThe view operation is required to view or search for a Document.\n","plainTextDescription":"A user must match at least one of these principals, or one of the\nprincipals in the owners or editors to be able to view the Document.\nThe view operation is required to view or search for a Document.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurityUpdateEventData"},"type":{"type":"object","object":{"properties":{"principalType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionarySecurityPrincipalType"}}},"safety":"SAFE","documentation":{"description":"Whether this event represents an all-principal or user/group-specific security change.","plainTextDescription":"Whether this event represents an all-principal or user/group-specific security change.","example":[]}},"previousDiscretionarySecurity":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"}}}}},"safety":"SAFE","documentation":{"description":"The previous discretionary security, if available.","plainTextDescription":"The previous discretionary security, if available.","example":[]}},"newDiscretionarySecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"}}},"safety":"SAFE","documentation":{"description":"The new discretionary security settings.","plainTextDescription":"The new discretionary security settings.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Activity event data emitted when a document's discretionary security is updated.\nA single user action that updates both all-principal and user/group-specific permissions\nwill trigger two separate events, one for each principal type.\n","plainTextDescription":"Activity event data emitted when a document's discretionary security is updated.\nA single user action that updates both all-principal and user/group-specific permissions\nwill trigger two separate events, one for each principal type.","example":[{"principalType":"ALL_PRINCIPAL"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentEditDescription"},"type":{"type":"object","object":{"properties":{"eventData":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentCustomEventData"}}},"safety":"UNSAFE","documentation":{"example":[]}},"eventType":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"NOTE: this field is deprecated and will be removed. The event type is\navailable on eventData.eventType.\n","plainTextDescription":"NOTE: this field is deprecated and will be removed. The event type is\navailable on eventData.eventType.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurity"},"type":{"type":"object","object":{"properties":{"classification":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingPrincipal"}}}}},"safety":"UNSAFE","documentation":{"description":"A set of CBAC markings that form a classification on the Document. If non-empty, a user must have access to \nthe classification formed by the markings to access the Document. Only data at or below this classification\ncan be added to the Document.\n","plainTextDescription":"A set of CBAC markings that form a classification on the Document. If non-empty, a user must have access to\nthe classification formed by the markings to access the Document. Only data at or below this classification\ncan be added to the Document.","example":[]}},"markings":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingId"}}}}},"safety":"SAFE","documentation":{"description":"Mandatory Markings controlling access to the Document. Users must have access to all Mandatory Markings to \nbe able to access the Document. Only unmarked data and data with any of these markings can be added to the \nDocument.\n","plainTextDescription":"Mandatory Markings controlling access to the Document. Users must have access to all Mandatory Markings to\nbe able to access the Document. Only unmarked data and data with any of these markings can be added to the\nDocument.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurityUpdateEventData"},"type":{"type":"object","object":{"properties":{"newClassification":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingPrincipal"}}}}},"safety":"UNSAFE","documentation":{"description":"The new CBAC classification markings on the document.","plainTextDescription":"The new CBAC classification markings on the document.","example":[]}},"newMarkings":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingId"}}}}},"safety":"SAFE","documentation":{"description":"The new mandatory markings on the document.","plainTextDescription":"The new mandatory markings on the document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document's mandatory security (classification and markings)\nis updated.\n","plainTextDescription":"Activity event data emitted when a document's mandatory security (classification and markings)\nis updated.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentMetadataUpdate"},"type":{"type":"object","object":{"properties":{"mandatorySecurityChanged":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether the update changed the document's mandatory security. Also will be true when the document is\nhard-deleted, moved under a different parent, or archived.\n","plainTextDescription":"Whether the update changed the document's mandatory security. Also will be true when the document is\nhard-deleted, moved under a different parent, or archived.","example":[]}},"discretionarySecurityChanged":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether the update changed the document's discretionary security. Also will be true when the document is\nhard-deleted or moved under a different parent.\n","plainTextDescription":"Whether the update changed the document's discretionary security. Also will be true when the document is\nhard-deleted or moved under a different parent.","example":[]}},"deleted":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether the document is hard-deleted or not. These events should only be expected once when hard-deleted,\nsince from then on the document is completely inaccessible.\n","plainTextDescription":"Whether the document is hard-deleted or not. These events should only be expected once when hard-deleted,\nsince from then on the document is completely inaccessible.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A websocket type sent over the document metadata channel when a metadata field has changed. The client\nshould reload the Document to retrieve the updated metadata values.\n","plainTextDescription":"A websocket type sent over the document metadata channel when a metadata field has changed. The client\nshould reload the Document to retrieve the updated metadata values.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentOntologyRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentOperation"},"type":{"type":"enum","enum":{"values":["VIEW","EDIT","OWN","DELETE"]}},"safety":"SAFE","documentation":{"description":"An operation that the requesting user is permitted to perform on a document, based on the\ndocument's security settings and the user's principals.\n","plainTextDescription":"An operation that the requesting user is permitted to perform on a document, based on the\ndocument's security settings and the user's principals.","example":["VIEW"]}},{"locator":{"namespaceName":"Pack","localName":"DocumentParent"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"parentFolder":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParentFolder"}}}},"namespace":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParentNamespace"}}}}}}},"safety":"SAFE","documentation":{"description":"The Gatekeeper parent the new Document is created under, also used with the documentTypeName to locate the\nassociated Document Type instance. The populated variant must match the file system required by that Document\nType: parentFolder for Compass-backed types, namespace for Artifact-backed types.\n","plainTextDescription":"The Gatekeeper parent the new Document is created under, also used with the documentTypeName to locate the\nassociated Document Type instance. The populated variant must match the file system required by that Document\nType: parentFolder for Compass-backed types, namespace for Artifact-backed types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentParentFolder"},"type":{"type":"object","object":{"properties":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A Compass folder parent for the new Document.","plainTextDescription":"A Compass folder parent for the new Document.","example":[{"folderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentParentNamespace"},"type":{"type":"object","object":{"properties":{"namespaceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"An Artifact's parent namespace for the new Document.","plainTextDescription":"An Artifact's parent namespace for the new Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentPresenceChangeEvent"},"type":{"type":"object","object":{"properties":{"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UserPresence"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document.\nNote that just because a user is not present on a particular document does not mean that they are overall\n\"offline\" -- they may have other documents or non-document applications open in the platform.\n","plainTextDescription":"Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document.\nNote that just because a user is not present on a particular document does not mean that they are overall\n\"offline\" -- they may have other documents or non-document applications open in the platform.","example":[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b","status":"PRESENT"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentPresenceSubscriptionRequest"},"type":{"type":"object","object":{"properties":{"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A request from client to subscribe to a document's presence updates, \nrequired on a subscription request to /documents/{documentId}/presence.\n","plainTextDescription":"A request from client to subscribe to a document's presence updates,\nrequired on a subscription request to /documents/{documentId}/presence.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentPublishMessage"},"type":{"type":"object","object":{"properties":{"yjsUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"YjsUpdate"}}},"safety":"UNSAFE","documentation":{"example":[]}},"editId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EditId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}},"documentUpdateSchemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The document type schema version that this document update is compatible with. This should be the highest\nfield version (see SchemaMetadata.addedInVersion) of the fields included in this update.\n","plainTextDescription":"The document type schema version that this document update is compatible with. This should be the highest\nfield version (see SchemaMetadata.addedInVersion) of the fields included in this update.","example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentEditDescription"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Update sent by client to apply to internal Y.Doc on server.\n","plainTextDescription":"Update sent by client to apply to internal Y.Doc on server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentRenameEventData"},"type":{"type":"object","object":{"properties":{"previousName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The previous name of the document.","plainTextDescription":"The previous name of the document.","example":[]}},"newName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The new name of the document.","plainTextDescription":"The new name of the document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document is renamed.\n","plainTextDescription":"Activity event data emitted when a document is renamed.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an PACK Document.\n","plainTextDescription":"Identifier for an PACK Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSearchQuery"},"type":{"type":"object","object":{"properties":{"documentName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The name of the document to search for.","plainTextDescription":"The name of the document to search for.","example":["MyDocument"]}}}}},"safety":"UNSAFE","documentation":{"description":"Filter criteria for document search.","plainTextDescription":"Filter criteria for document search.","example":[{"documentName":"MyDocument"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSearchRequest"},"type":{"type":"object","object":{"properties":{"ontologyRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"rid","rid":{}}}}},"safety":"SAFE","documentation":{"description":"The ontology RID to scope the document type search to. When provided it disambiguates document types\n(whose names are unique only within an ontology) and scopes results to that ontology. When omitted,\nthe document type name is searched across all ontologies.\n","plainTextDescription":"The ontology RID to scope the document type search to. When provided it disambiguates document types\n(whose names are unique only within an ontology) and scopes results to that ontology. When omitted,\nthe document type name is searched across all ontologies.","example":[]}},"query":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSearchQuery"}}}}},"safety":"UNSAFE","documentation":{"description":"Optional filter criteria for the search.","plainTextDescription":"Optional filter criteria for the search.","example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSort"}}}}},"safety":"SAFE","documentation":{"description":"Optional sorting specification.","plainTextDescription":"Optional sorting specification.","example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of documents to return. Defaults to 10.","plainTextDescription":"The maximum number of documents to return. Defaults to 10.","example":[10]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"PageToken"}}}}},"safety":"SAFE","documentation":{"description":"The page token indicates where to start paging. This should be omitted from the first page's request.\n","plainTextDescription":"The page token indicates where to start paging. This should be omitted from the first page's request.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request body for searching documents.","plainTextDescription":"Request body for searching documents.","example":[{"query":{"documentName":"MyDocument"},"orderBy":{"field":"NAME","direction":"ASC"},"pageSize":10}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSearchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of documents resulting from the search.","plainTextDescription":"The list of documents resulting from the search.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"PageToken"}}}}},"safety":"SAFE","documentation":{"description":"The token to indicate where to start paging for the next page of results.","plainTextDescription":"The token to indicate where to start paging for the next page of results.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"data":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"},"type":{"type":"object","object":{"properties":{"mandatory":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurity"}}},"safety":"UNSAFE","documentation":{"description":"The mandatory security restricts who can do anything with a Document, and what data the Document can access.\n","plainTextDescription":"The mandatory security restricts who can do anything with a Document, and what data the Document can access.","example":[]}},"discretionary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"}}},"safety":"SAFE","documentation":{"description":"The discretionary security controls who has what roles on the artifact once mandatory\nsecurity is satisfied.\n\nDiscretionary security always grants additional access, it is never restrictive.\n","plainTextDescription":"The discretionary security controls who has what roles on the artifact once mandatory\nsecurity is satisfied.\nDiscretionary security always grants additional access, it is never restrictive.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSort"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSortField"}}},"safety":"SAFE","documentation":{"description":"The field to sort by.","plainTextDescription":"The field to sort by.","example":[]}},"direction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"OrderByDirection"}}},"safety":"SAFE","documentation":{"description":"The sort direction.","plainTextDescription":"The sort direction.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Sorting specification for document search.","plainTextDescription":"Sorting specification for document search.","example":[{"field":"NAME","direction":"ASC"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSortField"},"type":{"type":"enum","enum":{"values":["NAME","CREATED_TIME","LAST_MODIFIED_TIME","LAST_VIEW_TIME"]}},"safety":"SAFE","documentation":{"description":"The field to sort documents by.","plainTextDescription":"The field to sort documents by.","example":["NAME"]}},{"locator":{"namespaceName":"Pack","localName":"DocumentStorageType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"yjs":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"YjsSchema"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The storage backend for a document type's schema.","plainTextDescription":"The storage backend for a document type's schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":["ri.backpack..document-type.12345"]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}},"operationalVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.\n","plainTextDescription":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.","example":[]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type for this document type. Defaults to ARTIFACTS if not specified.\n","plainTextDescription":"The file system type for this document type. Defaults to ARTIFACTS if not specified.","example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (workspace application id) of the application that owns this document type.\nEmpty if no owning application is configured.\n","plainTextDescription":"The stable identifier (workspace application id) of the application that owns this document type.\nEmpty if no owning application is configured.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAsset"},"type":{"type":"object","object":{"properties":{"comment":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Auto-generated comment with the asset generator name and version.\n","plainTextDescription":"Auto-generated comment with the asset generator name and version.","example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"documentStorageType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentStorageType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fileSystemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}},"safety":"SAFE","documentation":{"example":[]}},"schemaVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (workspace application id) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.\n","plainTextDescription":"The stable identifier (workspace application id) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.","example":[]}},"forceOverwrite":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, the existing schema is overwritten without running incremental schema validation.\nDefaults to false.\n","plainTextDescription":"If true, the existing schema is overwritten without running incremental schema validation.\nDefaults to false.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"First-party document type definition loaded from a published asset. Used by products that ship\ndocument-type schemas as part of their deployment.\n","plainTextDescription":"First-party document type definition loaded from a published asset. Used by products that ship\ndocument-type schemas as part of their deployment.","example":[{"fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The configured name for a DocumentType. This is unique within an ontology but not\nglobally unique.\n","plainTextDescription":"The configured name for a DocumentType. This is unique within an ontology but not\nglobally unique.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an PACK Document Type.\n","plainTextDescription":"Identifier for an PACK Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"},"type":{"type":"object","object":{"properties":{"primaryModelKeys":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}}}},"safety":"UNSAFE","documentation":{"description":"The primary models. There may be others described internally as nested/sub-models.","plainTextDescription":"The primary models. There may be others described internally as nested/sub-models.","example":[]}},"models":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelDef"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The schema definition for a real-time document type.","plainTextDescription":"The schema definition for a real-time document type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentUpdate"},"type":{"type":"object","object":{"properties":{"update":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"YjsUpdate"}}}}},"safety":"UNSAFE","documentation":{"description":"If this is an update from other client this is expected to be present.\nIf this is an update from the subscribing client (e.g. echoing back their own update), this will be empty.\nIf this is some other operation that does not modify the document content this will still be delivered to\nallow the client to advance the revisionId.\n","plainTextDescription":"If this is an update from other client this is expected to be present.\nIf this is an update from the subscribing client (e.g. echoing back their own update), this will be empty.\nIf this is some other operation that does not modify the document content this will still be delivered to\nallow the client to advance the revisionId.","example":[]}},"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}},"updateSchemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The lowest compatible schema version that the contents of this update complies with.","plainTextDescription":"The lowest compatible schema version that the contents of this update complies with.","example":[]}},"revisionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RevisionId"}}},"safety":"SAFE","documentation":{"description":"The revision id after this update has been applied.","plainTextDescription":"The revision id after this update has been applied.","example":[]}},"baseRevisionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RevisionId"}}},"safety":"SAFE","documentation":{"description":"The revision that this update is applied to. In the simple case this is revisionId - 1,\nhowever we may decide to batch updates in the future.\n","plainTextDescription":"The revision that this update is applied to. In the simple case this is revisionId - 1,\nhowever we may decide to batch updates in the future.","example":[]}},"editIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EditId"}}}}},"safety":"SAFE","documentation":{"description":"A list of the individual edit ids that are merged together in this document update.\n","plainTextDescription":"A list of the individual edit ids that are merged together in this document update.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Update broadcast to all clients after being applied on server.\n","plainTextDescription":"Update broadcast to all clients after being applied on server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentUpdateMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deletion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDeletionUpdate"}}}},"update":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentUpdate"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Union type to allow broadcasting different collaborative message types.\n","plainTextDescription":"Union type to allow broadcasting different collaborative message types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentUpdateSubscriptionRequest"},"type":{"type":"object","object":{"properties":{"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}},"lastRevisionId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RevisionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A request from client to subscribe to a document's collaborative updates, \nrequired on a subscription request to /documents/{documentId}/updates\n","plainTextDescription":"A request from client to subscribe to a document's collaborative updates,\nrequired on a subscription request to /documents/{documentId}/updates","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DoubleValue"},"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"EditId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A unique identifier for an edit to an AppKit Document.\n","plainTextDescription":"A unique identifier for an edit to an AppKit Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ErrorCode"},"type":{"type":"enum","enum":{"values":["INTERNAL_ERROR","REVISION_TOO_OLD","CLIENT_VERSION_TOO_LOW","DOCUMENT_TYPE_OPERATIONAL_VERSION_BUMPED"]}},"safety":"SAFE","documentation":{"example":["INTERNAL_ERROR"]}},{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"},"type":{"type":"object","object":{"properties":{"code":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorCode"}}},"safety":"SAFE","documentation":{"example":[]}},"errorInstanceId":{"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},"args":{"type":{"type":"map","map":{"keyType":{"type":"string","string":{}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Additional safe details about the error.","plainTextDescription":"Additional safe details about the error.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Message sent to clients when an error occurs. The subscription may not remain in a valid state after this\nmessage and should be reopened.\n","plainTextDescription":"Message sent to clients when an error occurs. The subscription may not remain in a valid state after this\nmessage and should be reopened.","example":[{"code":"INTERNAL_ERROR"}]}},{"locator":{"namespaceName":"Pack","localName":"EventDataUnion"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"documentCustomEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentCustomEventData"}}}},"documentCreate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentCreateEventData"}}}},"documentMandatorySecurityUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurityUpdateEventData"}}}},"documentRename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRenameEventData"}}}},"documentDiscretionarySecurityUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurityUpdateEventData"}}}},"documentDescriptionUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDescriptionUpdateEventData"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Union of all activity event data types. Platform-defined events have typed\ndata, while custom application-defined events use a versioned generic payload.\n","plainTextDescription":"Union of all activity event data types. Platform-defined events have typed\ndata, while custom application-defined events use a versioned generic payload.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"EventId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A unique identifier for this activity event.\n","plainTextDescription":"A unique identifier for this activity event.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldDef"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"isOptional":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"metadata":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeUnion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A field definition within a record.","plainTextDescription":"A field definition within a record.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A key identifying a field within a model.","plainTextDescription":"A key identifying a field within a model.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeArray"},"type":{"type":"object","object":{"properties":{"allowNullValue":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An array type with null value handling.","plainTextDescription":"An array type with null value handling.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeMap"},"type":{"type":"object","object":{"properties":{"allowNullValue":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A map type with key and value definitions.","plainTextDescription":"A map type with key and value definitions.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeSet"},"type":{"type":"object","object":{"properties":{"allowNullValue":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A set type with null value handling.","plainTextDescription":"A set type with null value handling.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeUnion"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeSet"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeArray"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeMap"}}}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The type of a field, which can be a collection, map, or value.","plainTextDescription":"The type of a field, which can be a collection, map, or value.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueBoolean"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A boolean field value with optional default.","plainTextDescription":"A boolean field value with optional default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueDatetime"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datetime field value.","plainTextDescription":"A datetime field value.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueDocumentRef"},"type":{"type":"object","object":{"properties":{"documentTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to another document.","plainTextDescription":"A reference to another document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueDouble"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DoubleValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DoubleValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DoubleValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A double field value with optional constraints and default.","plainTextDescription":"A double field value with optional constraints and default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueInteger"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"IntegerValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"IntegerValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"IntegerValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An integer field value with optional constraints and default.","plainTextDescription":"An integer field value with optional constraints and default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueMediaRef"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to media content.","plainTextDescription":"A reference to media content.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueModelRef"},"type":{"type":"object","object":{"properties":{"modelTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to another model within the schema.","plainTextDescription":"A reference to another model within the schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueObjectRef"},"type":{"type":"object","object":{"properties":{"interfaceTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to an ontology object or interface.","plainTextDescription":"A reference to an ontology object or interface.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueString"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A string field value with optional constraints and default.","plainTextDescription":"A string field value with optional constraints and default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueText"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A text field value with optional constraints and default.\nText should be used over string values for word-editor style complex text.\n","plainTextDescription":"A text field value with optional constraints and default.\nText should be used over string values for word-editor style complex text.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueType"},"type":{"type":"object","object":{"properties":{"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueUnion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The field value type for a field definition.\n","plainTextDescription":"The field value type for a field definition.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueUnion"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mediaRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueMediaRef"}}}},"modelRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueModelRef"}}}},"datetime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueDatetime"}}}},"userRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueUserRef"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueBoolean"}}}},"docRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueDocumentRef"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueString"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueDouble"}}}},"unmanagedJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueUnmanagedJson"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueInteger"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueText"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueObjectRef"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The possible value types for a field.","plainTextDescription":"The possible value types for a field.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueUnmanagedJson"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An unmanaged JSON field value.","plainTextDescription":"An unmanaged JSON field value.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueUserRef"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"A reference to a user.","plainTextDescription":"A reference to a user.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FileSystemType"},"type":{"type":"enum","enum":{"values":["ARTIFACTS","COMPASS"]}},"safety":"SAFE","documentation":{"description":"The file system backing storage for documents of this type. Documents can currently be stored in\nGotham Artifacts or in Compass.\n","plainTextDescription":"The file system backing storage for documents of this type. Documents can currently be stored in\nGotham Artifacts or in Compass.","example":["ARTIFACTS"]}},{"locator":{"namespaceName":"Pack","localName":"FolderRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier (RID) of a Folder.","plainTextDescription":"The unique resource identifier (RID) of a Folder.","example":["ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type to get the operational version for.","plainTextDescription":"The name of the document type to get the operational version for.","example":[]}},"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology that the document type belongs to.","plainTextDescription":"The ontology that the document type belongs to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionResponse"},"type":{"type":"object","object":{"properties":{"operationalVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.\n","plainTextDescription":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Response containing the operational version for a document type.","plainTextDescription":"Response containing the operational version for a document type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"GroupId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A Foundry Group ID.","plainTextDescription":"A Foundry Group ID.","example":["0d1fe74e-2b70-4a93-9b1a-80070637788b"]}},{"locator":{"namespaceName":"Pack","localName":"IntegerValue"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"InterfaceTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an ontology interface type.","plainTextDescription":"Identifier for an ontology interface type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type to load.","plainTextDescription":"The name of the document type to load.","example":[]}},"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology that the document type belongs to.","plainTextDescription":"The ontology that the document type belongs to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"MarkingId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A UUID representing a Mandatory Marking.\n","plainTextDescription":"A UUID representing a Mandatory Marking.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"MarkingPrincipal"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A portion marking used by CBAC (Classification based access control).\n","plainTextDescription":"A portion marking used by CBAC (Classification based access control).","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ModelDef"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"record":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RecordDef"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UnionDef"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A model definition, either a record or a union.","plainTextDescription":"A model definition, either a record or a union.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A key identifying a model type within the schema.","plainTextDescription":"A key identifying a model type within the schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for a namespace.\n","plainTextDescription":"Identifier for a namespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ObjectTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an ontology object type.","plainTextDescription":"Identifier for an ontology object type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"PageToken"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The page token indicates where to start paging on. This should be omitted from the first page's request.\nTo fetch the next page, clients should take the value from the `nextPageToken` field of the previous response\nand use it to populate the `pageToken` field of the next request.\n\napi-gateway's Core.PageToken is an immutable @Unsafe String, which is incompatible with PACK Document search.\nThis is a PACK API specific PageToken that is @Safe.\n","plainTextDescription":"The page token indicates where to start paging on. This should be omitted from the first page's request.\nTo fetch the next page, clients should take the value from the nextPageToken field of the previous response\nand use it to populate the pageToken field of the next request.\napi-gateway's Core.PageToken is an immutable @Unsafe String, which is incompatible with PACK Document search.\nThis is a PACK API specific PageToken that is @Safe.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"PresenceCollaborativeUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"presenceChangeEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentPresenceChangeEvent"}}}},"customPresenceEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CustomPresenceEvent"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"PresencePublishMessage"},"type":{"type":"object","object":{"properties":{"schemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The version of the presence event schema defining this data.","plainTextDescription":"The version of the presence event schema defining this data.","example":[]}},"messageType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"PresencePublishMessageType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"PresencePublishMessageType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"custom":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CustomPresenceEvent"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"RecordDef"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldDef"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A record model definition with named fields.","plainTextDescription":"A record model definition with named fields.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ResolveDocumentApplicationResponse"},"type":{"type":"object","object":{"properties":{"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (Workspace application ID) of the application that owns the document's type.\nEmpty if the document type has no owning application configured.\n","plainTextDescription":"The stable identifier (Workspace application ID) of the application that owns the document's type.\nEmpty if the document type has no owning application configured.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The application that owns a PACK Document, resolved via the document's type metadata.\n","plainTextDescription":"The application that owns a PACK Document, resolved via the document's type metadata.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"RevisionId"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"A unique incrementing identifier that represents the order of edits applied by the server.\n","plainTextDescription":"A unique incrementing identifier that represents the order of edits applied by the server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaMetadata"},"type":{"type":"object","object":{"properties":{"addedInVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}},"deprecatedFromVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}},"deprecatedMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about when a schema element was added or deprecated.","plainTextDescription":"Metadata about when a schema element was added or deprecated.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaValidationFailure"},"type":{"type":"object","object":{"properties":{"violations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaViolation"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of schema validation violations.","plainTextDescription":"The list of schema validation violations.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A failed schema validation result containing the list of violations.","plainTextDescription":"A failed schema validation result containing the list of violations.","example":[{"violations":[{"violationType":"FIELD_ADDED_WITH_INCORRECT_VERSION"}]}]}},{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"An incrementing version number for a document type schema. Each schema update\nincrements this value by one, representing a linear history of versions.\n","plainTextDescription":"An incrementing version number for a document type schema. Each schema update\nincrements this value by one, representing a linear history of versions.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaViolation"},"type":{"type":"object","object":{"properties":{"fieldPath":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The path to the field that caused the violation.","plainTextDescription":"The path to the field that caused the violation.","example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A human-readable message describing the violation.","plainTextDescription":"A human-readable message describing the violation.","example":[]}},"violationType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaViolationType"}}},"safety":"SAFE","documentation":{"description":"The type of violation.","plainTextDescription":"The type of violation.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A single schema validation violation.","plainTextDescription":"A single schema validation violation.","example":[{"violationType":"FIELD_ADDED_WITH_INCORRECT_VERSION"}]}},{"locator":{"namespaceName":"Pack","localName":"SchemaViolationType"},"type":{"type":"enum","enum":{"values":["FIELD_ADDED_WITH_INCORRECT_VERSION","FIELD_REMOVED","RECORD_REMOVED","UNION_VARIANT_MODIFICATION","UNION_REMOVED","INCORRECT_VERSION","ADDED_WITH_DEPRECATION","UNDEPRECATION_NOT_ALLOWED","FIELD_MODIFIED"]}},"safety":"SAFE","documentation":{"description":"The type of schema validation violation.","plainTextDescription":"The type of schema validation violation.","example":["FIELD_ADDED_WITH_INCORRECT_VERSION"]}},{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type for the documents to search for.","plainTextDescription":"The name of the document type for the documents to search for.","example":[]}},"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSearchRequest"}}},"safety":"UNSAFE","documentation":{"description":"The search request containing query, sort, and pagination options.","plainTextDescription":"The search request containing query, sort, and pagination options.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"requestBody":{"query":{"documentName":"MyDocument"},"orderBy":{"field":"NAME","direction":"ASC"},"pageSize":10}}]}},{"locator":{"namespaceName":"Pack","localName":"TextLength"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"UnionDef"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"discriminant":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"variants":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UnionVariantKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metadata":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A union model definition with variants.","plainTextDescription":"A union model definition with variants.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UnionVariantKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A key identifying a variant within a union.","plainTextDescription":"A key identifying a variant within a union.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentMetadataRequest"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The new name for the document. If not provided, the name remains unchanged.","plainTextDescription":"The new name for the document. If not provided, the name remains unchanged.","example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The new description for the document. If not provided, the description remains unchanged.\nUse empty string to clear the description.\n","plainTextDescription":"The new description for the document. If not provided, the description remains unchanged.\nUse empty string to clear the description.","example":[]}},"security":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}}}},"safety":"UNSAFE","documentation":{"description":"The new security settings for the document. If not provided, the security remains unchanged.\n","plainTextDescription":"The new security settings for the document. If not provided, the security remains unchanged.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to update document metadata (name, description, and/or security).","plainTextDescription":"Request to update document metadata (name, description, and/or security).","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentMetadataRequest"}}},"safety":"UNSAFE","documentation":{"description":"The request containing the fields to update.","plainTextDescription":"The request containing the fields to update.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type whose schema to update.","plainTextDescription":"The name of the document type whose schema to update.","example":[]}},"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request containing the updated schema and version.","plainTextDescription":"The request containing the updated schema and version.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaRequestBody"},"type":{"type":"object","object":{"properties":{"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology that the document type belongs to.","plainTextDescription":"The ontology that the document type belongs to.","example":[]}},"schema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}},"safety":"UNSAFE","documentation":{"description":"The updated schema for the document type.","plainTextDescription":"The updated schema for the document type.","example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"description":"The new schema version. The version must equal the current schema version + 1, unless the update is a force overwrite.","plainTextDescription":"The new schema version. The version must equal the current schema version + 1, unless the update is a force overwrite.","example":[]}},"forceOverwrite":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, bypass schema validation checks and force the update. Defaults to false.\n","plainTextDescription":"If true, bypass schema validation checks and force the update. Defaults to false.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to update a document type's schema.","plainTextDescription":"Request to update a document type's schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"success":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaSuccess"}}}},"validationFailure":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaValidationFailure"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The result of an update schema request.","plainTextDescription":"The result of an update schema request.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaSuccess"},"type":{"type":"object","object":{"properties":{"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"description":"The schema version after the update.","plainTextDescription":"The schema version after the update.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A successful schema update result.","plainTextDescription":"A successful schema update result.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UserId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A Foundry User ID.","plainTextDescription":"A Foundry User ID.","example":["0d1fe74e-2b70-4a93-9b1a-80070637788b"]}},{"locator":{"namespaceName":"Pack","localName":"UserPresence"},"type":{"type":"enum","enum":{"values":["PRESENT","NOT_PRESENT"]}},"safety":"SAFE","documentation":{"description":"A user's presence on a document\n","plainTextDescription":"A user's presence on a document","example":["PRESENT"]}},{"locator":{"namespaceName":"Pack","localName":"YjsSchema"},"type":{"type":"object","object":{"properties":{"schema":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Yjs-backed schema storage. If `schema` is empty, the schema for this document type could not be\nfound — this can happen for older document types that never persisted their schema; use the\nupdateSchema endpoint to populate it.\n","plainTextDescription":"Yjs-backed schema storage. If schema is empty, the schema for this document type could not be\nfound — this can happen for older document types that never persisted their schema; use the\nupdateSchema endpoint to populate it.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"YjsUpdate"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}}],"errors":[{"locator":{"namespaceName":"Pack","localName":"ArtifactDocumentCreationMissingNamespace"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Artifact-backed documents require a namespace upon creation.\n","plainTextDescription":"Artifact-backed documents require a namespace upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CannotDeleteAutosavedDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Autosaved documents cannot be deleted.\n","plainTextDescription":"Autosaved documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CannotDeleteHiddenDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Hidden documents cannot be deleted.\n","plainTextDescription":"Hidden documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationMissingParentFolder"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass-backed documents require a parent folder upon creation.\n","plainTextDescription":"Compass-backed documents require a parent folder upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationWithDiscretionarySecurityNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.\n","plainTextDescription":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createChild the Document.","plainTextDescription":"Could not createChild the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the Document.","plainTextDescription":"Could not create the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the DocumentType.","plainTextDescription":"Could not create the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2PermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createV2 the Document.","plainTextDescription":"Could not createV2 the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createMatchingSecurity the Document.","plainTextDescription":"Could not createMatchingSecurity the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createFirstParty the DocumentType.","plainTextDescription":"Could not createFirstParty the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DeleteDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not delete the Document.","plainTextDescription":"Could not delete the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAlreadyExists"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"This Document Type Name already exists for the given ontology.\n","plainTextDescription":"This Document Type Name already exists for the given ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotCompassBacked"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.\n","plainTextDescription":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":["ri.backpack..document-type.12345"]}}},"documentation":{"description":"The given DocumentType could not be found.","plainTextDescription":"The given DocumentType could not be found.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not getOperationalVersion the DocumentType.","plainTextDescription":"Could not getOperationalVersion the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidChildDocumentParent"},"errorType":"INVALID_ARGUMENT","parameters":{"parentResourceRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A child document's parent must be a folder or another document.\n","plainTextDescription":"A child document's parent must be a folder or another document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeName"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Name is invalid. First-party document type names must follow the format\n`com.palantir.pack..`.\n","plainTextDescription":"The provided Document Type Name is invalid. First-party document type names must follow the format\ncom.palantir.pack...","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeVersion"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Version is invalid. The version must be a positive integer.\n","plainTextDescription":"The provided Document Type Version is invalid. The version must be a positive integer.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not loadByName the DocumentType.","plainTextDescription":"Could not loadByName the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ResolveApplicationDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not resolveApplication the Document.","plainTextDescription":"Could not resolveApplication the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaUpdateConflict"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.\n","plainTextDescription":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not search the Document.","plainTextDescription":"Could not search the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentNotSupported"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to update this document, or the document does not exist.\n","plainTextDescription":"The user does not have permission to update this document, or the document does not exist.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not update the Document.","plainTextDescription":"Could not update the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not updateSchema the DocumentType.","plainTextDescription":"Could not updateSchema the DocumentType.","example":[]}}]}; +export const PackV2: Namespace = {"name":"Pack","version":"v2","resources":[{"singleton":false,"documentation":{"description":"A Document Type represents the user-defined schema for application state.","plainTextDescription":"A Document Type represents the user-defined schema for application state.","example":[]},"component":{"namespaceName":"Pack","localName":"DocumentType"},"idPropertyName":"rid","pluralName":"DocumentTypes","pathSegment":"documentTypes","operations":[{"name":"createDocumentType","verb":"create","documentation":{"description":"Creates a PACK Document Type with the provided schema and metadata.\n","plainTextDescription":"Creates a PACK Document Type with the provided schema and metadata.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"Example Document Type","fileSystemType":"ARTIFACTS"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"The created DocumentType","plainTextDescription":"The created DocumentType","example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAlreadyExists"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"This Document Type Name already exists for the given ontology.\n","plainTextDescription":"This Document Type Name already exists for the given ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForFolderNotFound"},"errorType":"NOT_FOUND","parameters":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.\n","plainTextDescription":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the DocumentType.","plainTextDescription":"Could not create the DocumentType.","example":[]}}]},{"name":"getDocumentType","verb":"get","documentation":{"description":"Get the DocumentType with the specified rid.","plainTextDescription":"Get the DocumentType with the specified rid.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/{documentTypeRid}","httpMethod":"GET","parameters":[{"name":"documentTypeRid","documentation":{"example":["ri.backpack..document-type.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":["ri.backpack..document-type.12345"]}}},"documentation":{"description":"The given DocumentType could not be found.","plainTextDescription":"The given DocumentType could not be found.","example":[]}}]},{"name":"loadByNameDocumentTypes","verb":"loadByName","documentation":{"description":"Loads the PACK Document Type's metadata by the provided Document Type Name.\n","plainTextDescription":"Loads the PACK Document Type's metadata by the provided Document Type Name.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/loadByName","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not loadByName the DocumentType.","plainTextDescription":"Could not loadByName the DocumentType.","example":[]}}]},{"name":"createFirstPartyDocumentType","verb":"createFirstParty","documentation":{"description":"Creates a first-party Document Type with the given schema in the specified ontology.\nThis is intended for use by internal Palantir workflows. For external application developers,\ndocument types should be created through the Create Document Type operation.\n","plainTextDescription":"Creates a first-party Document Type with the given schema in the specified ontology.\nThis is intended for use by internal Palantir workflows. For external application developers,\ndocument types should be created through the Create Document Type operation.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/createFirstParty","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requestBody":{"fileSystemType":"ARTIFACTS"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"fileSystemType":"ARTIFACTS"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAlreadyExists"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"This Document Type Name already exists for the given ontology.\n","plainTextDescription":"This Document Type Name already exists for the given ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeName"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Name is invalid. First-party document type names must follow the format\n`com.palantir.pack..`.\n","plainTextDescription":"The provided Document Type Name is invalid. First-party document type names must follow the format\ncom.palantir.pack...","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeVersion"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Version is invalid. The version must be a positive integer.\n","plainTextDescription":"The provided Document Type Version is invalid. The version must be a positive integer.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createFirstParty the DocumentType.","plainTextDescription":"Could not createFirstParty the DocumentType.","example":[]}}]},{"name":"updateSchemaDocumentType","verb":"updateSchema","documentation":{"description":"Updates the schema of a PACK Document Type. The new schema version must be strictly\ngreater than the current version. Schema validation is performed to ensure backwards\ncompatibility unless forceOverwrite is set to true.\n","plainTextDescription":"Updates the schema of a PACK Document Type. The new schema version must be strictly\ngreater than the current version. Schema validation is performed to ensure backwards\ncompatibility unless forceOverwrite is set to true.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/updateSchema","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeVersion"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Version is invalid. The version must be a positive integer.\n","plainTextDescription":"The provided Document Type Version is invalid. The version must be a positive integer.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaUpdateConflict"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.\n","plainTextDescription":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not updateSchema the DocumentType.","plainTextDescription":"Could not updateSchema the DocumentType.","example":[]}}]},{"name":"getOperationalVersionDocumentType","verb":"getOperationalVersion","documentation":{"description":"Returns the computed operational version for a document type. The operational version is the highest\nschema version that all deployed asset tracks can support, used for document compatibility checks.\n","plainTextDescription":"Returns the computed operational version for a document type. The operational version is the highest\nschema version that all deployed asset tracks can support, used for document compatibility checks.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documentTypes/getOperationalVersion","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypeRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionResponse"}}},"safety":"SAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not getOperationalVersion the DocumentType.","plainTextDescription":"Could not getOperationalVersion the DocumentType.","example":[]}}]}]},{"singleton":false,"documentation":{"description":"A Document represents an instance of application state.","plainTextDescription":"A Document represents an instance of application state.","example":[]},"component":{"namespaceName":"Pack","localName":"Document"},"idPropertyName":"id","pluralName":"Documents","pathSegment":"documents","operations":[{"name":"createDocument","verb":"create","documentation":{"description":"Deprecated: use `createV2` instead, which takes the document parent (namespace or folder)\ndirectly on the request.\n","plainTextDescription":"Deprecated: use createV2 instead, which takes the document parent (namespace or folder)\ndirectly on the request.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","ontologyRid":"ri.ontology.main.ontology.12345","name":"Example Document","description":"Example document description.","documentTypeName":"Example Document Type"}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"description":"The created Document","plainTextDescription":"The created Document","example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationMissingParentFolder"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass-backed documents require a parent folder upon creation.\n","plainTextDescription":"Compass-backed documents require a parent folder upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationWithDiscretionarySecurityNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.\n","plainTextDescription":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentName"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided document name must not be empty or consist only of whitespace.\n","plainTextDescription":"The provided document name must not be empty or consist only of whitespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForFolderNotFound"},"errorType":"NOT_FOUND","parameters":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.\n","plainTextDescription":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the Document.","plainTextDescription":"Could not create the Document.","example":[]}}]},{"name":"deleteDocument","verb":"delete","documentation":{"description":"Delete the Document with the specified id.","plainTextDescription":"Delete the Document with the specified id.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataDelete"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}","httpMethod":"DELETE","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[]},"body":{"type":"noContent","noContent":{}},"code":"204"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"CannotDeleteAutosavedDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Autosaved documents cannot be deleted.\n","plainTextDescription":"Autosaved documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CannotDeleteHiddenDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Hidden documents cannot be deleted.\n","plainTextDescription":"Hidden documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DeleteDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not delete the Document.","plainTextDescription":"Could not delete the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}}]},{"name":"getDocument","verb":"get","documentation":{"description":"Get the Document with the specified id.","plainTextDescription":"Get the Document with the specified id.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}","httpMethod":"GET","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForDocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.\n","plainTextDescription":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}}]},{"name":"searchDocuments","verb":"search","documentation":{"description":"Loads all PACK Documents visible to the user of the provided Document Type Name. If a search request\nis provided, filters and sorts the results based on the user's query, sort, and pagination options.\nWhen an ontology RID is provided on the request, results are scoped to that ontology; otherwise the\ndocument type name is searched across all ontologies.\n","plainTextDescription":"Loads all PACK Documents visible to the user of the provided Document Type Name. If a search request\nis provided, filters and sorts the results based on the user's query, sort, and pagination options.\nWhen an ontology RID is provided on the request, results are scoped to that ontology; otherwise the\ndocument type name is searched across all ontologies.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataLoad"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/search","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requestBody":{"query":{"documentName":"MyDocument"},"orderBy":{"field":"NAME","direction":"ASC"},"pageSize":10}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"data":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSearchResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not search the Document.","plainTextDescription":"Could not search the Document.","example":[]}}]},{"name":"updateDocument","verb":"update","documentation":{"description":"Updates the metadata (name, description, and/or security) of a PACK Document.\n","plainTextDescription":"Updates the metadata (name, description, and/or security) of a PACK Document.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataUpdate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}/update","httpMethod":"POST","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentNotSupported"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to update this document, or the document does not exist.\n","plainTextDescription":"The user does not have permission to update this document, or the document does not exist.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not update the Document.","plainTextDescription":"Could not update the Document.","example":[]}}]},{"name":"resolveApplicationDocument","verb":"resolveApplication","documentation":{"description":"Resolves a PACK Document to the application that owns its Document Type. Returns the owning\napplication id from the document type metadata, or empty if none is configured.\n","plainTextDescription":"Resolves a PACK Document to the application that owns its Document Type. Returns the owning\napplication id from the document type metadata, or empty if none is configured.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["metaDataAccess"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-read"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/{documentId}/resolveApplication","httpMethod":"GET","parameters":[{"name":"documentId","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]},"inputType":"PATH","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"response":{"documentation":{"example":[]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ResolveDocumentApplicationResponse"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"ResolveApplicationDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not resolveApplication the Document.","plainTextDescription":"Could not resolveApplication the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}}]},{"name":"createDocumentAsChild","verb":"createChild","documentation":{"description":"Creates a PACK Document as a hidden child of the given folder or document, inheriting its security and staying\nin sync as the parent's security changes.\n","plainTextDescription":"Creates a PACK Document as a hidden child of the given folder or document, inheriting its security and staying\nin sync as the parent's security changes.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/createChild","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotCompassBacked"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.\n","plainTextDescription":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidChildDocumentParent"},"errorType":"INVALID_ARGUMENT","parameters":{"parentResourceRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A child document's parent must be a folder or another document.\n","plainTextDescription":"A child document's parent must be a folder or another document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentName"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided document name must not be empty or consist only of whitespace.\n","plainTextDescription":"The provided document name must not be empty or consist only of whitespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForFolderNotFound"},"errorType":"NOT_FOUND","parameters":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.\n","plainTextDescription":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForDocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.\n","plainTextDescription":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createChild the Document.","plainTextDescription":"Could not createChild the Document.","example":[]}}]},{"name":"createDocumentWithMatchingSecurity","verb":"createMatchingSecurity","documentation":{"description":"Creates a PACK Document that copies the directly-applied security markings of a source Document. The\nnew Document's security is independent of the source's afterward.\n","plainTextDescription":"Creates a PACK Document that copies the directly-applied security markings of a source Document. The\nnew Document's security is independent of the source's afterward.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/createMatchingSecurity","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[{"requestBody":{"destinationFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}}]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityRequest"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotCompassBacked"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.\n","plainTextDescription":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentName"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided document name must not be empty or consist only of whitespace.\n","plainTextDescription":"The provided document name must not be empty or consist only of whitespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForFolderNotFound"},"errorType":"NOT_FOUND","parameters":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.\n","plainTextDescription":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForDocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.\n","plainTextDescription":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createMatchingSecurity the Document.","plainTextDescription":"Could not createMatchingSecurity the Document.","example":[]}}]},{"name":"createDocumentV2","verb":"createV2","documentation":{"description":"Creates a PACK Document and returns it.\n","plainTextDescription":"Creates a PACK Document and returns it.","example":[]},"releaseStage":"PRIVATE_BETA","auditCategories":["dataCreate"],"auth":{"includeAuthHeader":true,"scopes":["api:pack-write"],"expandedScopes":[]},"http":{"path":"/v2/pack/documents/createV2","httpMethod":"POST","parameters":[{"name":"preview","documentation":{"description":"Enables the use of preview functionality.","plainTextDescription":"Enables the use of preview functionality.","example":[]},"inputType":"QUERY","type":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PreviewMode"}}}}},"safety":"SAFE","documentation":{"example":[]}}}],"requestBody":{"documentation":{"example":[]},"body":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2Request"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"response":{"documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]},"body":{"type":"ok","ok":{"responseType":{"type":"component","component":{"mediaType":"application/json","type":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}},"safety":"UNSAFE","documentation":{"example":[]}}}},"required":true}},"code":"200"}},"throwableErrors":[{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ArtifactDocumentCreationMissingNamespace"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Artifact-backed documents require a namespace upon creation.\n","plainTextDescription":"Artifact-backed documents require a namespace upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationMissingParentFolder"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass-backed documents require a parent folder upon creation.\n","plainTextDescription":"Compass-backed documents require a parent folder upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationWithDiscretionarySecurityNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.\n","plainTextDescription":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentName"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided document name must not be empty or consist only of whitespace.\n","plainTextDescription":"The provided document name must not be empty or consist only of whitespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForFolderNotFound"},"errorType":"NOT_FOUND","parameters":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.\n","plainTextDescription":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2PermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createV2 the Document.","plainTextDescription":"Could not createV2 the Document.","example":[]}}]}]}],"components":[{"locator":{"namespaceName":"Pack","localName":"ActivityCollaborativeUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"activityDeleted":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ActivityDeleted"}}}},"activityCreated":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ActivityCreated"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event broadcast to all clients after being applied on server.\n","plainTextDescription":"Activity event broadcast to all clients after being applied on server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ActivityCreated"},"type":{"type":"object","object":{"properties":{"activityEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ActivityEvent"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The event that gets published to PACK channels to update a users activity feed as new events\nare added to a particular resource.\n","plainTextDescription":"The event that gets published to PACK channels to update a users activity feed as new events\nare added to a particular resource.","example":[{"activityEvent":{"createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","createdTime":"2024-09-25T17:29:35.974Z"}}]}},{"locator":{"namespaceName":"Pack","localName":"ActivityDeleted"},"type":{"type":"object","object":{"properties":{"eventId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EventId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"aggregationKey":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The event that gets published to PACK channels to update a users activity feed whenever an event\nis removed from a particular resource.\n","plainTextDescription":"The event that gets published to PACK channels to update a users activity feed whenever an event\nis removed from a particular resource.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ActivityEvent"},"type":{"type":"object","object":{"properties":{"eventId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EventId"}}},"safety":"UNSAFE","documentation":{"example":[]}},"eventData":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EventDataUnion"}}},"safety":"UNSAFE","documentation":{"example":[]}},"isRead":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"aggregationKey":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"Producer defined key to determine how activity events should be aggregated when displayed\non the FE. If this event is not to be grouped at all, provide the same value as the eventId\nto guarantee this event will not be aggregated with any others.\n","plainTextDescription":"Producer defined key to determine how activity events should be aggregated when displayed\non the FE. If this event is not to be grouped at all, provide the same value as the eventId\nto guarantee this event will not be aggregated with any others.","example":[]}},"createdBy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedBy"}}},"safety":"SAFE","documentation":{"example":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}},"createdTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedTime"}}},"safety":"SAFE","documentation":{"example":["2024-09-25T17:29:35.974Z"]}}}}},"safety":"UNSAFE","documentation":{"description":"A single activity event associated with a particular document. The eventData union\ndiscriminant determines the type of event: platform-defined events (e.g. document create,\nrename, security changes) and custom application-defined events.\n","plainTextDescription":"A single activity event associated with a particular document. The eventData union\ndiscriminant determines the type of event: platform-defined events (e.g. document create,\nrename, security changes) and custom application-defined events.","example":[{"createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","createdTime":"2024-09-25T17:29:35.974Z"}]}},{"locator":{"namespaceName":"Pack","localName":"AllPrincipal"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An empty type representing all users in the system. Useful for expressing\noperations that should be allowed by what is typically the 'Everyone' group,\nor for expressing that anyone who satisfies Mandatory security is granted\ndiscretionary access.\n","plainTextDescription":"An empty type representing all users in the system. Useful for expressing\noperations that should be allowed by what is typically the 'Everyone' group,\nor for expressing that anyone who satisfies Mandatory security is granted\ndiscretionary access.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ClientId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"},"type":{"type":"object","object":{"properties":{"minVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}},"maxVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"PACK clients may support a range of document type schema versions. This allows for schema upgrades while\nmaintaining cross-client collaboration compatibility.\n","plainTextDescription":"PACK clients may support a range of document type schema versions. This allows for schema upgrades while\nmaintaining cross-client collaboration compatibility.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateChildDocumentRequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"parentResourceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"ResourceRid"}}},"safety":"UNSAFE","documentation":{"description":"The folder or document the new Document is created under and inherits security from.\nMust be a folder or another document; any other resource type is rejected with \n`InvalidChildDocumentParent`.\n","plainTextDescription":"The folder or document the new Document is created under and inherits security from.\nMust be a folder or another document; any other resource type is rejected with\nInvalidChildDocumentParent.","example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The Document Type to instantiate, resolved by name in the namespace of the parent resource.\n","plainTextDescription":"The Document Type to instantiate, resolved by name in the namespace of the parent resource.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a Document as a hidden child of a hidden child of a folder or document. The Document inherits its\nsecurity from the parent resource and stays in sync as the parent's security changes.\n","plainTextDescription":"Request to create a Document as a hidden child of a hidden child of a folder or document. The Document inherits its\nsecurity from the parent resource and stays in sync as the parent's security changes.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateChildDocumentRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a child document.","plainTextDescription":"The request to create a child document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentMatchingSecurityRequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"sourceDocumentRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"description":"The Document whose directly-applied markings are copied onto the new Document.","plainTextDescription":"The Document whose directly-applied markings are copied onto the new Document.","example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The Document Type to instantiate, resolved by name in the namespace of the new Document's parent -\nthe destinationFolderRid when provided, otherwise the source Document's parent.\n","plainTextDescription":"The Document Type to instantiate, resolved by name in the namespace of the new Document's parent -\nthe destinationFolderRid when provided, otherwise the source Document's parent.","example":[]}},"destinationFolderRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}}}},"safety":"SAFE","documentation":{"description":"The folder to create the new Document in. If absent, the new Document is created under the same\nparent as the source Document.\n","plainTextDescription":"The folder to create the new Document in. If absent, the new Document is created under the same\nparent as the source Document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a Document whose security is a one-time copy of a source Document's directly-applied\nmarkings. The new Document's security is independent of the source's afterward.\n","plainTextDescription":"Request to create a Document whose security is a one-time copy of a source Document's directly-applied\nmarkings. The new Document's security is independent of the source's afterward.","example":[{"destinationFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentRequest"},"type":{"type":"object","object":{"properties":{"parentFolderRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}}}},"safety":"SAFE","documentation":{"description":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.\n","plainTextDescription":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.","example":[]}},"security":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}},"safety":"UNSAFE","documentation":{"example":[]}},"ontologyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentOntologyRid"}}},"safety":"SAFE","documentation":{"example":["ri.ontology.main.ontology.12345"]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document"]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":["Example document description."]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}}}}},"safety":"UNSAFE","documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","ontologyRid":"ri.ontology.main.ontology.12345","name":"Example Document","description":"Example document description.","documentTypeName":"Example Document Type"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"parentFolderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"description":"The RID of the folder to create this document type in.\n","plainTextDescription":"The RID of the folder to create this document type in.","example":[]}},"schema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}},"safety":"UNSAFE","documentation":{"description":"The user-defined schema for this document type.","plainTextDescription":"The user-defined schema for this document type.","example":[]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type for this document type. Defaults to ARTIFACTS if not specified.\n","plainTextDescription":"The file system type for this document type. Defaults to ARTIFACTS if not specified.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"Example Document Type","fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2Request"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2RequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a document.","plainTextDescription":"The request to create a document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2RequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the Document Type to instantiate.","plainTextDescription":"The name of the Document Type to instantiate.","example":[]}},"security":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}},"safety":"UNSAFE","documentation":{"example":[]}},"parent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}},"safety":"SAFE","documentation":{"description":"The Gatekeeper parent the new Document is created under.\n","plainTextDescription":"The Gatekeeper parent the new Document is created under.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a PACK Document.","plainTextDescription":"Request to create a PACK Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateDocumentMatchingSecurityRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a document matching the security of a source document.","plainTextDescription":"The request to create a document matching the security of a source document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"requestBody":{"destinationFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}}]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request to create a first-party document type.","plainTextDescription":"The request to create a first-party document type.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"requestBody":{"fileSystemType":"ARTIFACTS"}}]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeRequestBody"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The fully qualified name of the document type. Must follow the format\n`com.palantir.pack..`.\n","plainTextDescription":"The fully qualified name of the document type. Must follow the format\ncom.palantir.pack...","example":[]}},"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology to create the document type in.","plainTextDescription":"The ontology to create the document type in.","example":[]}},"schema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}},"safety":"UNSAFE","documentation":{"description":"The schema for the document type.","plainTextDescription":"The schema for the document type.","example":[]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type. Defaults to ARTIFACTS if not specified.","plainTextDescription":"The file system type. Defaults to ARTIFACTS if not specified.","example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.\n","plainTextDescription":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.","example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The schema version.","plainTextDescription":"The schema version.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to create a first-party document type.","plainTextDescription":"Request to create a first-party document type.","example":[{"fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypeResponse"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"description":"The RID of the created document type.","plainTextDescription":"The RID of the created document type.","example":[]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the created document type.","plainTextDescription":"The name of the created document type.","example":[]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type.","plainTextDescription":"The file system type.","example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The schema version.","plainTextDescription":"The schema version.","example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.\n","plainTextDescription":"The stable identifier (Workspace application ID) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Response for creating a first-party document type.","plainTextDescription":"Response for creating a first-party document type.","example":[{"fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"CustomPresenceEvent"},"type":{"type":"object","object":{"properties":{"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"description":"On publish, server validates that the user ID matches the token provided.","plainTextDescription":"On publish, server validates that the user ID matches the token provided.","example":[]}},"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"eventData":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"eventType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"example":[]}},"schemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The version of the presence event schema defining this data.","plainTextDescription":"The version of the presence event schema defining this data.","example":[]}},"isEphemeral":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"Ephemeral messages are custom presence events that are not persisted. Defaults to false.\n\nThis field helps clients determine whether an event is a transient message or should be \npersisted to be fetched upon new clients joining or on reload. Ephemeral messages are processed faster\nwithout a DB write and should be used for messages that are not crucial for clients to receive on join, \ne.g. a user's cursor position on screen.\n","plainTextDescription":"Ephemeral messages are custom presence events that are not persisted. Defaults to false.\nThis field helps clients determine whether an event is a transient message or should be\npersisted to be fetched upon new clients joining or on reload. Ephemeral messages are processed faster\nwithout a DB write and should be used for messages that are not crucial for clients to receive on join,\ne.g. a user's cursor position on screen.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b"}]}},{"locator":{"namespaceName":"Pack","localName":"DeletionMethod"},"type":{"type":"enum","enum":{"values":["TRASHED","ARCHIVED","HARD_DELETED"]}},"safety":"SAFE","documentation":{"description":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.\n","plainTextDescription":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.","example":["TRASHED"]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"all":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"AllPrincipal"}}}},"groupId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalGroupId"}}}},"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalUserId"}}}}}}},"safety":"SAFE","documentation":{"description":"Union of all security principals usable within disjunctive security conditions.\n\nThese principals are used to grant additional role access beyond mandatory security.\n\nThis includes the special 'all' principal, which grants access to any users who meet mandatory\nfor a given discretionary role.\n","plainTextDescription":"Union of all security principals usable within disjunctive security conditions.\nThese principals are used to grant additional role access beyond mandatory security.\nThis includes the special 'all' principal, which grants access to any users who meet mandatory\nfor a given discretionary role.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalGroupId"},"type":{"type":"object","object":{"properties":{"groupId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"GroupId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[{"groupId":"0d1fe74e-2b70-4a93-9b1a-80070637788b"}]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipalUserId"},"type":{"type":"object","object":{"properties":{"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"example":[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b"}]}},{"locator":{"namespaceName":"Pack","localName":"DiscretionarySecurityPrincipalType"},"type":{"type":"enum","enum":{"values":["ALL_PRINCIPAL","USER"]}},"safety":"SAFE","documentation":{"description":"Indicates whether a discretionary security update event corresponds to all-principal\npermissions or user/group-specific permissions.\n","plainTextDescription":"Indicates whether a discretionary security update event corresponds to all-principal\npermissions or user/group-specific permissions.","example":["ALL_PRINCIPAL"]}},{"locator":{"namespaceName":"Pack","localName":"Document"},"type":{"type":"object","object":{"properties":{"id":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}},"ontologyRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentOntologyRid"}}},"safety":"SAFE","documentation":{"example":["ri.ontology.main.ontology.12345"]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document"]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":["Example document description."]}},"parentFolderRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}}}},"safety":"SAFE","documentation":{"description":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.\n","plainTextDescription":"Creating compass backed Documents requires a parent folder rid. If creating an artifact backed\nDocument, leave this field empty.","example":[]}},"security":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}},"safety":"UNSAFE","documentation":{"example":[]}},"createdBy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedBy"}}},"safety":"SAFE","documentation":{"example":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}},"createdTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"CreatedTime"}}},"safety":"SAFE","documentation":{"example":["2024-09-25T17:29:35.974Z"]}},"updatedBy":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UpdatedBy"}}},"safety":"SAFE","documentation":{"example":["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]}},"updatedTime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UpdatedTime"}}},"safety":"SAFE","documentation":{"example":["2024-09-25T17:29:35.974Z"]}},"operations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentOperation"}}}}},"safety":"SAFE","documentation":{"description":"The set of operations the requesting user is permitted to perform on this document,\nderived from the document's discretionary security settings and the user's principals.\nClients can use this to determine which UI actions (e.g. edit, delete) to enable.\n","plainTextDescription":"The set of operations the requesting user is permitted to perform on this document,\nderived from the document's discretionary security settings and the user's principals.\nClients can use this to determine which UI actions (e.g. edit, delete) to enable.","example":[]}},"operationalVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The computed operational version for this document, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.\n","plainTextDescription":"The computed operational version for this document, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentActivitySubscriptionRequest"},"type":{"type":"object","object":{"properties":{"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A request from client to subscribe to a document's activity updates, \nrequired on a subscription request to /documents/{documentId}/activity.\n","plainTextDescription":"A request from client to subscribe to a document's activity updates,\nrequired on a subscription request to /documents/{documentId}/activity.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentCreateEventData"},"type":{"type":"object","object":{"properties":{"initialMandatorySecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurity"}}},"safety":"UNSAFE","documentation":{"description":"The mandatory security set on the document at creation time.","plainTextDescription":"The mandatory security set on the document at creation time.","example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The name of the created document.","plainTextDescription":"The name of the created document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document is created.\n","plainTextDescription":"Activity event data emitted when a document is created.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentCustomEventData"},"type":{"type":"object","object":{"properties":{"eventType":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The application-defined event type name as registered in the document schema.\nUsed to distinguish between different custom event subtypes within the custom event category.\n","plainTextDescription":"The application-defined event type name as registered in the document schema.\nUsed to distinguish between different custom event subtypes within the custom event category.","example":[]}},"data":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"description":"The custom event payload data, structured according to the event type's schema definition.","plainTextDescription":"The custom event payload data, structured according to the event type's schema definition.","example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The version of the event schema defining this event data.\nNOTE: this field is deprecated and will be removed. Please use schemaVersion.\n","plainTextDescription":"The version of the event schema defining this event data.\nNOTE: this field is deprecated and will be removed. Please use schemaVersion.","example":[]}},"schemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"integer","integer":{}}}}},"safety":"SAFE","documentation":{"description":"The version of the event schema defining this event data.","plainTextDescription":"The version of the event schema defining this event data.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Versioned event data for custom application-defined activity events.\n","plainTextDescription":"Versioned event data for custom application-defined activity events.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDeletionUpdate"},"type":{"type":"object","object":{"properties":{"deletionMethod":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DeletionMethod"}}},"safety":"SAFE","documentation":{"description":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.\n","plainTextDescription":"Deletion method type describing whether the resource was trashed (Compass), archived (Artifacts), or\nhard-deleted.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Update broadcast to all clients upon document deletion. Attempting to resubscribe to this document after\ndeletion will fail with permission denied.\n","plainTextDescription":"Update broadcast to all clients upon document deletion. Attempting to resubscribe to this document after\ndeletion will fail with permission denied.","example":[{"deletionMethod":"TRASHED"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDescriptionUpdateEventData"},"type":{"type":"object","object":{"properties":{"newDescription":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The new description of the document.","plainTextDescription":"The new description of the document.","example":[]}},"isInitial":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"True if this is the first time the description is being set,\nfalse if updating an existing description.\n","plainTextDescription":"True if this is the first time the description is being set,\nfalse if updating an existing description.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document's description is updated.\n","plainTextDescription":"Activity event data emitted when a document's description is updated.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"},"type":{"type":"object","object":{"properties":{"owners":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"}}}}},"safety":"SAFE","documentation":{"description":"A user must match at least one of these principals to be granted\nownership of the Document. This field is required to be non-empty.\n\nThe own operation is required to change Document security and to delete Documents.\n\nIf the creator of the Document is not included in \"owners\", they will not\nbe able to delete or change the Document's security.\n","plainTextDescription":"A user must match at least one of these principals to be granted\nownership of the Document. This field is required to be non-empty.\nThe own operation is required to change Document security and to delete Documents.\nIf the creator of the Document is not included in \"owners\", they will not\nbe able to delete or change the Document's security.","example":[]}},"editors":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"}}}}},"safety":"SAFE","documentation":{"description":"A user must match at least one of these principals, or one of the\nprincipals in the owners to be granted able to edit the Document.\n\nThe edit operation is required to perform any kind of edit to a Document.\n","plainTextDescription":"A user must match at least one of these principals, or one of the\nprincipals in the owners to be granted able to edit the Document.\nThe edit operation is required to perform any kind of edit to a Document.","example":[]}},"viewers":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionaryPrincipal"}}}}},"safety":"SAFE","documentation":{"description":"A user must match at least one of these principals, or one of the\nprincipals in the owners or editors to be able to view the Document.\n\nThe view operation is required to view or search for a Document.\n","plainTextDescription":"A user must match at least one of these principals, or one of the\nprincipals in the owners or editors to be able to view the Document.\nThe view operation is required to view or search for a Document.","example":[]}}}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurityUpdateEventData"},"type":{"type":"object","object":{"properties":{"principalType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DiscretionarySecurityPrincipalType"}}},"safety":"SAFE","documentation":{"description":"Whether this event represents an all-principal or user/group-specific security change.","plainTextDescription":"Whether this event represents an all-principal or user/group-specific security change.","example":[]}},"previousDiscretionarySecurity":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"}}}}},"safety":"SAFE","documentation":{"description":"The previous discretionary security, if available.","plainTextDescription":"The previous discretionary security, if available.","example":[]}},"newDiscretionarySecurity":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"}}},"safety":"SAFE","documentation":{"description":"The new discretionary security settings.","plainTextDescription":"The new discretionary security settings.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Activity event data emitted when a document's discretionary security is updated.\nA single user action that updates both all-principal and user/group-specific permissions\nwill trigger two separate events, one for each principal type.\n","plainTextDescription":"Activity event data emitted when a document's discretionary security is updated.\nA single user action that updates both all-principal and user/group-specific permissions\nwill trigger two separate events, one for each principal type.","example":[{"principalType":"ALL_PRINCIPAL"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentEditDescription"},"type":{"type":"object","object":{"properties":{"eventData":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentCustomEventData"}}},"safety":"UNSAFE","documentation":{"example":[]}},"eventType":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"NOTE: this field is deprecated and will be removed. The event type is\navailable on eventData.eventType.\n","plainTextDescription":"NOTE: this field is deprecated and will be removed. The event type is\navailable on eventData.eventType.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurity"},"type":{"type":"object","object":{"properties":{"classification":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingPrincipal"}}}}},"safety":"UNSAFE","documentation":{"description":"A set of CBAC markings that form a classification on the Document. If non-empty, a user must have access to \nthe classification formed by the markings to access the Document. Only data at or below this classification\ncan be added to the Document.\n","plainTextDescription":"A set of CBAC markings that form a classification on the Document. If non-empty, a user must have access to\nthe classification formed by the markings to access the Document. Only data at or below this classification\ncan be added to the Document.","example":[]}},"markings":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingId"}}}}},"safety":"SAFE","documentation":{"description":"Mandatory Markings controlling access to the Document. Users must have access to all Mandatory Markings to \nbe able to access the Document. Only unmarked data and data with any of these markings can be added to the \nDocument.\n","plainTextDescription":"Mandatory Markings controlling access to the Document. Users must have access to all Mandatory Markings to\nbe able to access the Document. Only unmarked data and data with any of these markings can be added to the\nDocument.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurityUpdateEventData"},"type":{"type":"object","object":{"properties":{"newClassification":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingPrincipal"}}}}},"safety":"UNSAFE","documentation":{"description":"The new CBAC classification markings on the document.","plainTextDescription":"The new CBAC classification markings on the document.","example":[]}},"newMarkings":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"MarkingId"}}}}},"safety":"SAFE","documentation":{"description":"The new mandatory markings on the document.","plainTextDescription":"The new mandatory markings on the document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document's mandatory security (classification and markings)\nis updated.\n","plainTextDescription":"Activity event data emitted when a document's mandatory security (classification and markings)\nis updated.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentMetadataUpdate"},"type":{"type":"object","object":{"properties":{"mandatorySecurityChanged":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether the update changed the document's mandatory security. Also will be true when the document is\nhard-deleted, moved under a different parent, or archived.\n","plainTextDescription":"Whether the update changed the document's mandatory security. Also will be true when the document is\nhard-deleted, moved under a different parent, or archived.","example":[]}},"discretionarySecurityChanged":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether the update changed the document's discretionary security. Also will be true when the document is\nhard-deleted or moved under a different parent.\n","plainTextDescription":"Whether the update changed the document's discretionary security. Also will be true when the document is\nhard-deleted or moved under a different parent.","example":[]}},"deleted":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"description":"Whether the document is hard-deleted or not. These events should only be expected once when hard-deleted,\nsince from then on the document is completely inaccessible.\n","plainTextDescription":"Whether the document is hard-deleted or not. These events should only be expected once when hard-deleted,\nsince from then on the document is completely inaccessible.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A websocket type sent over the document metadata channel when a metadata field has changed. The client\nshould reload the Document to retrieve the updated metadata values.\n","plainTextDescription":"A websocket type sent over the document metadata channel when a metadata field has changed. The client\nshould reload the Document to retrieve the updated metadata values.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentOntologyRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentOperation"},"type":{"type":"enum","enum":{"values":["VIEW","EDIT","OWN","DELETE"]}},"safety":"SAFE","documentation":{"description":"An operation that the requesting user is permitted to perform on a document, based on the\ndocument's security settings and the user's principals.\n","plainTextDescription":"An operation that the requesting user is permitted to perform on a document, based on the\ndocument's security settings and the user's principals.","example":["VIEW"]}},{"locator":{"namespaceName":"Pack","localName":"DocumentParent"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"parentFolder":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParentFolder"}}}},"namespace":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParentNamespace"}}}}}}},"safety":"SAFE","documentation":{"description":"The Gatekeeper parent the new Document is created under, also used with the documentTypeName to locate the\nassociated Document Type instance. The populated variant must match the file system required by that Document\nType: parentFolder for Compass-backed types, namespace for Artifact-backed types.\n","plainTextDescription":"The Gatekeeper parent the new Document is created under, also used with the documentTypeName to locate the\nassociated Document Type instance. The populated variant must match the file system required by that Document\nType: parentFolder for Compass-backed types, namespace for Artifact-backed types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentParentFolder"},"type":{"type":"object","object":{"properties":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A Compass folder parent for the new Document.","plainTextDescription":"A Compass folder parent for the new Document.","example":[{"folderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentParentNamespace"},"type":{"type":"object","object":{"properties":{"namespaceRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"An Artifact's parent namespace for the new Document.","plainTextDescription":"An Artifact's parent namespace for the new Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentPresenceChangeEvent"},"type":{"type":"object","object":{"properties":{"userId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"UserId"}}},"safety":"SAFE","documentation":{"example":[]}},"status":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UserPresence"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document.\nNote that just because a user is not present on a particular document does not mean that they are overall\n\"offline\" -- they may have other documents or non-document applications open in the platform.\n","plainTextDescription":"Sent when a user's presence changes on a document. That is, sent when a user opens or closes the document.\nNote that just because a user is not present on a particular document does not mean that they are overall\n\"offline\" -- they may have other documents or non-document applications open in the platform.","example":[{"userId":"0d1fe74e-2b70-4a93-9b1a-80070637788b","status":"PRESENT"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentPresenceSubscriptionRequest"},"type":{"type":"object","object":{"properties":{"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A request from client to subscribe to a document's presence updates, \nrequired on a subscription request to /documents/{documentId}/presence.\n","plainTextDescription":"A request from client to subscribe to a document's presence updates,\nrequired on a subscription request to /documents/{documentId}/presence.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentPublishMessage"},"type":{"type":"object","object":{"properties":{"yjsUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"YjsUpdate"}}},"safety":"UNSAFE","documentation":{"example":[]}},"editId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EditId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}},"documentUpdateSchemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The document type schema version that this document update is compatible with. This should be the highest\nfield version (see SchemaMetadata.addedInVersion) of the fields included in this update.\n","plainTextDescription":"The document type schema version that this document update is compatible with. This should be the highest\nfield version (see SchemaMetadata.addedInVersion) of the fields included in this update.","example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentEditDescription"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Update sent by client to apply to internal Y.Doc on server.\n","plainTextDescription":"Update sent by client to apply to internal Y.Doc on server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentRenameEventData"},"type":{"type":"object","object":{"properties":{"previousName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The previous name of the document.","plainTextDescription":"The previous name of the document.","example":[]}},"newName":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The new name of the document.","plainTextDescription":"The new name of the document.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Activity event data emitted when a document is renamed.\n","plainTextDescription":"Activity event data emitted when a document is renamed.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an PACK Document.\n","plainTextDescription":"Identifier for an PACK Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSearchQuery"},"type":{"type":"object","object":{"properties":{"documentName":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The name of the document to search for.","plainTextDescription":"The name of the document to search for.","example":["MyDocument"]}}}}},"safety":"UNSAFE","documentation":{"description":"Filter criteria for document search.","plainTextDescription":"Filter criteria for document search.","example":[{"documentName":"MyDocument"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSearchRequest"},"type":{"type":"object","object":{"properties":{"ontologyRid":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"rid","rid":{}}}}},"safety":"SAFE","documentation":{"description":"The ontology RID to scope the document type search to. When provided it disambiguates document types\n(whose names are unique only within an ontology) and scopes results to that ontology. When omitted,\nthe document type name is searched across all ontologies.\n","plainTextDescription":"The ontology RID to scope the document type search to. When provided it disambiguates document types\n(whose names are unique only within an ontology) and scopes results to that ontology. When omitted,\nthe document type name is searched across all ontologies.","example":[]}},"query":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSearchQuery"}}}}},"safety":"UNSAFE","documentation":{"description":"Optional filter criteria for the search.","plainTextDescription":"Optional filter criteria for the search.","example":[]}},"orderBy":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSort"}}}}},"safety":"SAFE","documentation":{"description":"Optional sorting specification.","plainTextDescription":"Optional sorting specification.","example":[]}},"pageSize":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"PageSize"}}}}},"safety":"SAFE","documentation":{"description":"The maximum number of documents to return. Defaults to 10.","plainTextDescription":"The maximum number of documents to return. Defaults to 10.","example":[10]}},"pageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"PageToken"}}}}},"safety":"SAFE","documentation":{"description":"The page token indicates where to start paging. This should be omitted from the first page's request.\n","plainTextDescription":"The page token indicates where to start paging. This should be omitted from the first page's request.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request body for searching documents.","plainTextDescription":"Request body for searching documents.","example":[{"query":{"documentName":"MyDocument"},"orderBy":{"field":"NAME","direction":"ASC"},"pageSize":10}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSearchResponse"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"Document"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of documents resulting from the search.","plainTextDescription":"The list of documents resulting from the search.","example":[]}},"nextPageToken":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"PageToken"}}}}},"safety":"SAFE","documentation":{"description":"The token to indicate where to start paging for the next page of results.","plainTextDescription":"The token to indicate where to start paging for the next page of results.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"data":[{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","updatedTime":"2024-09-25T17:29:35.974Z","updatedBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","operations":["VIEW"],"ontologyRid":"ri.ontology.main.ontology.12345","createdBy":"f05f8da4-b84c-4fca-9c77-8af0b13d11de","name":"Example Document","description":"Example document description.","createdTime":"2024-09-25T17:29:35.974Z","id":"ri.gotham-artifact.0-1.document.12345","documentTypeName":"Example Document Type"}]}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"},"type":{"type":"object","object":{"properties":{"mandatory":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurity"}}},"safety":"UNSAFE","documentation":{"description":"The mandatory security restricts who can do anything with a Document, and what data the Document can access.\n","plainTextDescription":"The mandatory security restricts who can do anything with a Document, and what data the Document can access.","example":[]}},"discretionary":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurity"}}},"safety":"SAFE","documentation":{"description":"The discretionary security controls who has what roles on the artifact once mandatory\nsecurity is satisfied.\n\nDiscretionary security always grants additional access, it is never restrictive.\n","plainTextDescription":"The discretionary security controls who has what roles on the artifact once mandatory\nsecurity is satisfied.\nDiscretionary security always grants additional access, it is never restrictive.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSort"},"type":{"type":"object","object":{"properties":{"field":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSortField"}}},"safety":"SAFE","documentation":{"description":"The field to sort by.","plainTextDescription":"The field to sort by.","example":[]}},"direction":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Core","localName":"OrderByDirection"}}},"safety":"SAFE","documentation":{"description":"The sort direction.","plainTextDescription":"The sort direction.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Sorting specification for document search.","plainTextDescription":"Sorting specification for document search.","example":[{"field":"NAME","direction":"ASC"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentSortField"},"type":{"type":"enum","enum":{"values":["NAME","CREATED_TIME","LAST_MODIFIED_TIME","LAST_VIEW_TIME"]}},"safety":"SAFE","documentation":{"description":"The field to sort documents by.","plainTextDescription":"The field to sort documents by.","example":["NAME"]}},{"locator":{"namespaceName":"Pack","localName":"DocumentStorageType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"yjs":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"YjsSchema"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The storage backend for a document type's schema.","plainTextDescription":"The storage backend for a document type's schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentType"},"type":{"type":"object","object":{"properties":{"rid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":["ri.backpack..document-type.12345"]}},"name":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":["Example Document Type"]}},"operationalVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.\n","plainTextDescription":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.","example":[]}},"fileSystemType":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}}}},"safety":"SAFE","documentation":{"description":"The file system type for this document type. Defaults to ARTIFACTS if not specified.\n","plainTextDescription":"The file system type for this document type. Defaults to ARTIFACTS if not specified.","example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (workspace application id) of the application that owns this document type.\nEmpty if no owning application is configured.\n","plainTextDescription":"The stable identifier (workspace application id) of the application that owns this document type.\nEmpty if no owning application is configured.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"name":"Example Document Type","rid":"ri.backpack..document-type.12345","fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAsset"},"type":{"type":"object","object":{"properties":{"comment":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Auto-generated comment with the asset generator name and version.\n","plainTextDescription":"Auto-generated comment with the asset generator name and version.","example":[]}},"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"documentStorageType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentStorageType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fileSystemType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FileSystemType"}}},"safety":"SAFE","documentation":{"example":[]}},"schemaVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}},"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (workspace application id) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.\n","plainTextDescription":"The stable identifier (workspace application id) of the application that owns this document type. Used\nto resolve documents of this type to the application that should open them.","example":[]}},"forceOverwrite":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, the existing schema is overwritten without running incremental schema validation.\nDefaults to false.\n","plainTextDescription":"If true, the existing schema is overwritten without running incremental schema validation.\nDefaults to false.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"First-party document type definition loaded from a published asset. Used by products that ship\ndocument-type schemas as part of their deployment.\n","plainTextDescription":"First-party document type definition loaded from a published asset. Used by products that ship\ndocument-type schemas as part of their deployment.","example":[{"fileSystemType":"ARTIFACTS"}]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The configured name for a DocumentType. This is unique within an ontology but not\nglobally unique.\n","plainTextDescription":"The configured name for a DocumentType. This is unique within an ontology but not\nglobally unique.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an PACK Document Type.\n","plainTextDescription":"Identifier for an PACK Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"},"type":{"type":"object","object":{"properties":{"primaryModelKeys":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}}}},"safety":"UNSAFE","documentation":{"description":"The primary models. There may be others described internally as nested/sub-models.","plainTextDescription":"The primary models. There may be others described internally as nested/sub-models.","example":[]}},"models":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelDef"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The schema definition for a real-time document type.","plainTextDescription":"The schema definition for a real-time document type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentUpdate"},"type":{"type":"object","object":{"properties":{"update":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"YjsUpdate"}}}}},"safety":"UNSAFE","documentation":{"description":"If this is an update from other client this is expected to be present.\nIf this is an update from the subscribing client (e.g. echoing back their own update), this will be empty.\nIf this is some other operation that does not modify the document content this will still be delivered to\nallow the client to advance the revisionId.\n","plainTextDescription":"If this is an update from other client this is expected to be present.\nIf this is an update from the subscribing client (e.g. echoing back their own update), this will be empty.\nIf this is some other operation that does not modify the document content this will still be delivered to\nallow the client to advance the revisionId.","example":[]}},"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}},"updateSchemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The lowest compatible schema version that the contents of this update complies with.","plainTextDescription":"The lowest compatible schema version that the contents of this update complies with.","example":[]}},"revisionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RevisionId"}}},"safety":"SAFE","documentation":{"description":"The revision id after this update has been applied.","plainTextDescription":"The revision id after this update has been applied.","example":[]}},"baseRevisionId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RevisionId"}}},"safety":"SAFE","documentation":{"description":"The revision that this update is applied to. In the simple case this is revisionId - 1,\nhowever we may decide to batch updates in the future.\n","plainTextDescription":"The revision that this update is applied to. In the simple case this is revisionId - 1,\nhowever we may decide to batch updates in the future.","example":[]}},"editIds":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"EditId"}}}}},"safety":"SAFE","documentation":{"description":"A list of the individual edit ids that are merged together in this document update.\n","plainTextDescription":"A list of the individual edit ids that are merged together in this document update.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Update broadcast to all clients after being applied on server.\n","plainTextDescription":"Update broadcast to all clients after being applied on server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentUpdateMessage"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"deletion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDeletionUpdate"}}}},"update":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentUpdate"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Union type to allow broadcasting different collaborative message types.\n","plainTextDescription":"Union type to allow broadcasting different collaborative message types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentUpdateSubscriptionRequest"},"type":{"type":"object","object":{"properties":{"clientId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientId"}}},"safety":"SAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}},"lastRevisionId":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RevisionId"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A request from client to subscribe to a document's collaborative updates, \nrequired on a subscription request to /documents/{documentId}/updates\n","plainTextDescription":"A request from client to subscribe to a document's collaborative updates,\nrequired on a subscription request to /documents/{documentId}/updates","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DoubleValue"},"type":{"type":"builtin","builtin":{"type":"double","double":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"EditId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"A unique identifier for an edit to an AppKit Document.\n","plainTextDescription":"A unique identifier for an edit to an AppKit Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ErrorCode"},"type":{"type":"enum","enum":{"values":["INTERNAL_ERROR","REVISION_TOO_OLD","CLIENT_VERSION_TOO_LOW","DOCUMENT_TYPE_OPERATIONAL_VERSION_BUMPED"]}},"safety":"SAFE","documentation":{"example":["INTERNAL_ERROR"]}},{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"},"type":{"type":"object","object":{"properties":{"code":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorCode"}}},"safety":"SAFE","documentation":{"example":[]}},"errorInstanceId":{"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"example":[]}},"args":{"type":{"type":"map","map":{"keyType":{"type":"string","string":{}},"valueType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"SAFE","documentation":{"description":"Additional safe details about the error.","plainTextDescription":"Additional safe details about the error.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Message sent to clients when an error occurs. The subscription may not remain in a valid state after this\nmessage and should be reopened.\n","plainTextDescription":"Message sent to clients when an error occurs. The subscription may not remain in a valid state after this\nmessage and should be reopened.","example":[{"code":"INTERNAL_ERROR"}]}},{"locator":{"namespaceName":"Pack","localName":"EventDataUnion"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"documentCustomEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentCustomEventData"}}}},"documentCreate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentCreateEventData"}}}},"documentMandatorySecurityUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentMandatorySecurityUpdateEventData"}}}},"documentRename":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRenameEventData"}}}},"documentDiscretionarySecurityUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDiscretionarySecurityUpdateEventData"}}}},"documentDescriptionUpdate":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentDescriptionUpdateEventData"}}}}}}},"safety":"UNSAFE","documentation":{"description":"Union of all activity event data types. Platform-defined events have typed\ndata, while custom application-defined events use a versioned generic payload.\n","plainTextDescription":"Union of all activity event data types. Platform-defined events have typed\ndata, while custom application-defined events use a versioned generic payload.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"EventId"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A unique identifier for this activity event.\n","plainTextDescription":"A unique identifier for this activity event.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldDef"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"isOptional":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}},"metadata":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}},"fieldType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeUnion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A field definition within a record.","plainTextDescription":"A field definition within a record.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A key identifying a field within a model.","plainTextDescription":"A key identifying a field within a model.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeArray"},"type":{"type":"object","object":{"properties":{"allowNullValue":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An array type with null value handling.","plainTextDescription":"An array type with null value handling.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeMap"},"type":{"type":"object","object":{"properties":{"allowNullValue":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A map type with key and value definitions.","plainTextDescription":"A map type with key and value definitions.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeSet"},"type":{"type":"object","object":{"properties":{"allowNullValue":{"type":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}},"safety":"SAFE","documentation":{"example":[]}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A set type with null value handling.","plainTextDescription":"A set type with null value handling.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldTypeUnion"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"set":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeSet"}}}},"array":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeArray"}}}},"map":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldTypeMap"}}}},"value":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueType"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The type of a field, which can be a collection, map, or value.","plainTextDescription":"The type of a field, which can be a collection, map, or value.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueBoolean"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A boolean field value with optional default.","plainTextDescription":"A boolean field value with optional default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueDatetime"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A datetime field value.","plainTextDescription":"A datetime field value.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueDocumentRef"},"type":{"type":"object","object":{"properties":{"documentTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to another document.","plainTextDescription":"A reference to another document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueDouble"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DoubleValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DoubleValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DoubleValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A double field value with optional constraints and default.","plainTextDescription":"A double field value with optional constraints and default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueInteger"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"IntegerValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"IntegerValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"maxValue":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"IntegerValue"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"An integer field value with optional constraints and default.","plainTextDescription":"An integer field value with optional constraints and default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueMediaRef"},"type":{"type":"object","object":{"properties":{"value":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to media content.","plainTextDescription":"A reference to media content.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueModelRef"},"type":{"type":"object","object":{"properties":{"modelTypes":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A reference to another model within the schema.","plainTextDescription":"A reference to another model within the schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueObjectRef"},"type":{"type":"object","object":{"properties":{"interfaceTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"InterfaceTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}},"objectTypeRids":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ObjectTypeRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"SAFE","documentation":{"description":"A reference to an ontology object or interface.","plainTextDescription":"A reference to an ontology object or interface.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueString"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A string field value with optional constraints and default.","plainTextDescription":"A string field value with optional constraints and default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueText"},"type":{"type":"object","object":{"properties":{"defaultValue":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"minLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}},"maxLength":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"TextLength"}}}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A text field value with optional constraints and default.\nText should be used over string values for word-editor style complex text.\n","plainTextDescription":"A text field value with optional constraints and default.\nText should be used over string values for word-editor style complex text.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueType"},"type":{"type":"object","object":{"properties":{"valueType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueUnion"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The field value type for a field definition.\n","plainTextDescription":"The field value type for a field definition.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueUnion"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"mediaRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueMediaRef"}}}},"modelRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueModelRef"}}}},"datetime":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueDatetime"}}}},"userRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueUserRef"}}}},"boolean":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueBoolean"}}}},"docRef":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueDocumentRef"}}}},"string":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueString"}}}},"double":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueDouble"}}}},"unmanagedJson":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueUnmanagedJson"}}}},"integer":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueInteger"}}}},"text":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueText"}}}},"object":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldValueObjectRef"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The possible value types for a field.","plainTextDescription":"The possible value types for a field.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueUnmanagedJson"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"An unmanaged JSON field value.","plainTextDescription":"An unmanaged JSON field value.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FieldValueUserRef"},"type":{"type":"object","object":{"properties":{}}},"safety":"SAFE","documentation":{"description":"A reference to a user.","plainTextDescription":"A reference to a user.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"FileSystemType"},"type":{"type":"enum","enum":{"values":["ARTIFACTS","COMPASS"]}},"safety":"SAFE","documentation":{"description":"The file system backing storage for documents of this type. Documents can currently be stored in\nGotham Artifacts or in Compass.\n","plainTextDescription":"The file system backing storage for documents of this type. Documents can currently be stored in\nGotham Artifacts or in Compass.","example":["ARTIFACTS"]}},{"locator":{"namespaceName":"Pack","localName":"FolderRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The unique resource identifier (RID) of a Folder.","plainTextDescription":"The unique resource identifier (RID) of a Folder.","example":["ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type to get the operational version for.","plainTextDescription":"The name of the document type to get the operational version for.","example":[]}},"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology that the document type belongs to.","plainTextDescription":"The ontology that the document type belongs to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionResponse"},"type":{"type":"object","object":{"properties":{"operationalVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.\n","plainTextDescription":"The computed operational version for this document type, representing the highest schema version\nthat all deployed asset tracks can support. If this document type is not asset-deployed, operational\nversion is the highest supported version of any document subscriber or publisher.\nEmpty if no operational version has been computed yet.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"Response containing the operational version for a document type.","plainTextDescription":"Response containing the operational version for a document type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"GroupId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A Foundry Group ID.","plainTextDescription":"A Foundry Group ID.","example":["0d1fe74e-2b70-4a93-9b1a-80070637788b"]}},{"locator":{"namespaceName":"Pack","localName":"IntegerValue"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"InterfaceTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an ontology interface type.","plainTextDescription":"Identifier for an ontology interface type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type to load.","plainTextDescription":"The name of the document type to load.","example":[]}},"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology that the document type belongs to.","plainTextDescription":"The ontology that the document type belongs to.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"MarkingId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A UUID representing a Mandatory Marking.\n","plainTextDescription":"A UUID representing a Mandatory Marking.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"MarkingPrincipal"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A portion marking used by CBAC (Classification based access control).\n","plainTextDescription":"A portion marking used by CBAC (Classification based access control).","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ModelDef"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"record":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"RecordDef"}}}},"union":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UnionDef"}}}}}}},"safety":"UNSAFE","documentation":{"description":"A model definition, either a record or a union.","plainTextDescription":"A model definition, either a record or a union.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A key identifying a model type within the schema.","plainTextDescription":"A key identifying a model type within the schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for a namespace.\n","plainTextDescription":"Identifier for a namespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ObjectTypeRid"},"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"Identifier for an ontology object type.","plainTextDescription":"Identifier for an ontology object type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"PageToken"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"SAFE","documentation":{"description":"The page token indicates where to start paging on. This should be omitted from the first page's request.\nTo fetch the next page, clients should take the value from the `nextPageToken` field of the previous response\nand use it to populate the `pageToken` field of the next request.\n\napi-gateway's Core.PageToken is an immutable @Unsafe String, which is incompatible with PACK Document search.\nThis is a PACK API specific PageToken that is @Safe.\n","plainTextDescription":"The page token indicates where to start paging on. This should be omitted from the first page's request.\nTo fetch the next page, clients should take the value from the nextPageToken field of the previous response\nand use it to populate the pageToken field of the next request.\napi-gateway's Core.PageToken is an immutable @Unsafe String, which is incompatible with PACK Document search.\nThis is a PACK API specific PageToken that is @Safe.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"PresenceCollaborativeUpdate"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"presenceChangeEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentPresenceChangeEvent"}}}},"customPresenceEvent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CustomPresenceEvent"}}}},"error":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ErrorMessage"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"PresencePublishMessage"},"type":{"type":"object","object":{"properties":{"schemaVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"description":"The version of the presence event schema defining this data.","plainTextDescription":"The version of the presence event schema defining this data.","example":[]}},"messageType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"PresencePublishMessageType"}}},"safety":"UNSAFE","documentation":{"example":[]}},"clientSupportedVersionRange":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ClientSupportedVersionRange"}}},"safety":"SAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"PresencePublishMessageType"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"custom":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"CustomPresenceEvent"}}}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"RecordDef"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"fields":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldDef"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A record model definition with named fields.","plainTextDescription":"A record model definition with named fields.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ResolveDocumentApplicationResponse"},"type":{"type":"object","object":{"properties":{"owningApplicationId":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The stable identifier (Workspace application ID) of the application that owns the document's type.\nEmpty if the document type has no owning application configured.\n","plainTextDescription":"The stable identifier (Workspace application ID) of the application that owns the document's type.\nEmpty if the document type has no owning application configured.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"The application that owns a PACK Document, resolved via the document's type metadata.\n","plainTextDescription":"The application that owns a PACK Document, resolved via the document's type metadata.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"RevisionId"},"type":{"type":"builtin","builtin":{"type":"long","long":{}}},"safety":"SAFE","documentation":{"description":"A unique incrementing identifier that represents the order of edits applied by the server.\n","plainTextDescription":"A unique incrementing identifier that represents the order of edits applied by the server.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaMetadata"},"type":{"type":"object","object":{"properties":{"addedInVersion":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"example":[]}},"deprecatedFromVersion":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}},"deprecatedMessage":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Metadata about when a schema element was added or deprecated.","plainTextDescription":"Metadata about when a schema element was added or deprecated.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaValidationFailure"},"type":{"type":"object","object":{"properties":{"violations":{"type":{"type":"list","list":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaViolation"}}}}},"safety":"UNSAFE","documentation":{"description":"The list of schema validation violations.","plainTextDescription":"The list of schema validation violations.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A failed schema validation result containing the list of violations.","plainTextDescription":"A failed schema validation result containing the list of violations.","example":[{"violations":[{"violationType":"FIELD_ADDED_WITH_INCORRECT_VERSION"}]}]}},{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"description":"An incrementing version number for a document type schema. Each schema update\nincrements this value by one, representing a linear history of versions.\n","plainTextDescription":"An incrementing version number for a document type schema. Each schema update\nincrements this value by one, representing a linear history of versions.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaViolation"},"type":{"type":"object","object":{"properties":{"fieldPath":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"The path to the field that caused the violation.","plainTextDescription":"The path to the field that caused the violation.","example":[]}},"message":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A human-readable message describing the violation.","plainTextDescription":"A human-readable message describing the violation.","example":[]}},"violationType":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaViolationType"}}},"safety":"SAFE","documentation":{"description":"The type of violation.","plainTextDescription":"The type of violation.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A single schema validation violation.","plainTextDescription":"A single schema validation violation.","example":[{"violationType":"FIELD_ADDED_WITH_INCORRECT_VERSION"}]}},{"locator":{"namespaceName":"Pack","localName":"SchemaViolationType"},"type":{"type":"enum","enum":{"values":["FIELD_ADDED_WITH_INCORRECT_VERSION","FIELD_REMOVED","RECORD_REMOVED","UNION_VARIANT_MODIFICATION","UNION_REMOVED","INCORRECT_VERSION","ADDED_WITH_DEPRECATION","UNDEPRECATION_NOT_ALLOWED","FIELD_MODIFIED"]}},"safety":"SAFE","documentation":{"description":"The type of schema validation violation.","plainTextDescription":"The type of schema validation violation.","example":["FIELD_ADDED_WITH_INCORRECT_VERSION"]}},{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type for the documents to search for.","plainTextDescription":"The name of the document type for the documents to search for.","example":[]}},"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSearchRequest"}}},"safety":"UNSAFE","documentation":{"description":"The search request containing query, sort, and pagination options.","plainTextDescription":"The search request containing query, sort, and pagination options.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[{"requestBody":{"query":{"documentName":"MyDocument"},"orderBy":{"field":"NAME","direction":"ASC"},"pageSize":10}}]}},{"locator":{"namespaceName":"Pack","localName":"TextLength"},"type":{"type":"builtin","builtin":{"type":"integer","integer":{}}},"safety":"SAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"UnionDef"},"type":{"type":"object","object":{"properties":{"key":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"discriminant":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"FieldKey"}}},"safety":"UNSAFE","documentation":{"example":[]}},"name":{"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"variants":{"type":{"type":"map","map":{"keyType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UnionVariantKey"}}},"valueType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"ModelTypeKey"}}}}},"safety":"UNSAFE","documentation":{"example":[]}},"metadata":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaMetadata"}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"A union model definition with variants.","plainTextDescription":"A union model definition with variants.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UnionVariantKey"},"type":{"type":"builtin","builtin":{"type":"string","string":{}}},"safety":"UNSAFE","documentation":{"description":"A key identifying a variant within a union.","plainTextDescription":"A key identifying a variant within a union.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentMetadataRequest"},"type":{"type":"object","object":{"properties":{"name":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The new name for the document. If not provided, the name remains unchanged.","plainTextDescription":"The new name for the document. If not provided, the name remains unchanged.","example":[]}},"description":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"string","string":{}}}}},"safety":"UNSAFE","documentation":{"description":"The new description for the document. If not provided, the description remains unchanged.\nUse empty string to clear the description.\n","plainTextDescription":"The new description for the document. If not provided, the description remains unchanged.\nUse empty string to clear the description.","example":[]}},"security":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentSecurity"}}}}},"safety":"UNSAFE","documentation":{"description":"The new security settings for the document. If not provided, the security remains unchanged.\n","plainTextDescription":"The new security settings for the document. If not provided, the security remains unchanged.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to update document metadata (name, description, and/or security).","plainTextDescription":"Request to update document metadata (name, description, and/or security).","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentRequest"},"type":{"type":"object","object":{"properties":{"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentMetadataRequest"}}},"safety":"UNSAFE","documentation":{"description":"The request containing the fields to update.","plainTextDescription":"The request containing the fields to update.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypeRequest"},"type":{"type":"object","object":{"properties":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"description":"The name of the document type whose schema to update.","plainTextDescription":"The name of the document type whose schema to update.","example":[]}},"requestBody":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaRequestBody"}}},"safety":"UNSAFE","documentation":{"description":"The request containing the updated schema and version.","plainTextDescription":"The request containing the updated schema and version.","example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaRequestBody"},"type":{"type":"object","object":{"properties":{"ontologyRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"description":"The ontology that the document type belongs to.","plainTextDescription":"The ontology that the document type belongs to.","example":[]}},"schema":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}},"safety":"UNSAFE","documentation":{"description":"The updated schema for the document type.","plainTextDescription":"The updated schema for the document type.","example":[]}},"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"description":"The new schema version. The version must equal the current schema version + 1, unless the update is a force overwrite.","plainTextDescription":"The new schema version. The version must equal the current schema version + 1, unless the update is a force overwrite.","example":[]}},"forceOverwrite":{"type":{"type":"optional","optional":{"subType":{"type":"builtin","builtin":{"type":"boolean","boolean":{}}}}},"safety":"SAFE","documentation":{"description":"If true, bypass schema validation checks and force the update. Defaults to false.\n","plainTextDescription":"If true, bypass schema validation checks and force the update. Defaults to false.","example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Request to update a document type's schema.","plainTextDescription":"Request to update a document type's schema.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaResponse"},"type":{"type":"union","union":{"discriminator":"type","subTypes":{"success":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaSuccess"}}}},"validationFailure":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaValidationFailure"}}}}}}},"safety":"UNSAFE","documentation":{"description":"The result of an update schema request.","plainTextDescription":"The result of an update schema request.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaSuccess"},"type":{"type":"object","object":{"properties":{"version":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}},"safety":"SAFE","documentation":{"description":"The schema version after the update.","plainTextDescription":"The schema version after the update.","example":[]}}}}},"safety":"SAFE","documentation":{"description":"A successful schema update result.","plainTextDescription":"A successful schema update result.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UserId"},"type":{"type":"builtin","builtin":{"type":"uuid","uuid":{}}},"safety":"SAFE","documentation":{"description":"A Foundry User ID.","plainTextDescription":"A Foundry User ID.","example":["0d1fe74e-2b70-4a93-9b1a-80070637788b"]}},{"locator":{"namespaceName":"Pack","localName":"UserPresence"},"type":{"type":"enum","enum":{"values":["PRESENT","NOT_PRESENT"]}},"safety":"SAFE","documentation":{"description":"A user's presence on a document\n","plainTextDescription":"A user's presence on a document","example":["PRESENT"]}},{"locator":{"namespaceName":"Pack","localName":"YjsSchema"},"type":{"type":"object","object":{"properties":{"schema":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeSchema"}}}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"description":"Yjs-backed schema storage. If `schema` is empty, the schema for this document type could not be\nfound — this can happen for older document types that never persisted their schema; use the\nupdateSchema endpoint to populate it.\n","plainTextDescription":"Yjs-backed schema storage. If schema is empty, the schema for this document type could not be\nfound — this can happen for older document types that never persisted their schema; use the\nupdateSchema endpoint to populate it.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"YjsUpdate"},"type":{"type":"object","object":{"properties":{"data":{"type":{"type":"builtin","builtin":{"type":"any","any":{}}},"safety":"UNSAFE","documentation":{"example":[]}}}}},"safety":"UNSAFE","documentation":{"example":[]}}],"errors":[{"locator":{"namespaceName":"Pack","localName":"ArtifactDocumentCreationMissingNamespace"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Artifact-backed documents require a namespace upon creation.\n","plainTextDescription":"Artifact-backed documents require a namespace upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CannotDeleteAutosavedDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Autosaved documents cannot be deleted.\n","plainTextDescription":"Autosaved documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CannotDeleteHiddenDocument"},"errorType":"INVALID_ARGUMENT","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Hidden documents cannot be deleted.\n","plainTextDescription":"Hidden documents cannot be deleted.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationMissingParentFolder"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"providedParent":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentParent"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass-backed documents require a parent folder upon creation.\n","plainTextDescription":"Compass-backed documents require a parent folder upon creation.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CompassDocumentCreationWithDiscretionarySecurityNotSupported"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.\n","plainTextDescription":"Compass backed documents do not support discretionary security on creation. The creating user will be an\nowner of the document by default.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentAsChildPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createChild the Document.","plainTextDescription":"Could not createChild the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentOfTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to create documents of this Document Type.\n","plainTextDescription":"The user does not have permission to create documents of this Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the Document.","plainTextDescription":"Could not create the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not create the DocumentType.","plainTextDescription":"Could not create the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentV2PermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createV2 the Document.","plainTextDescription":"Could not createV2 the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateDocumentWithMatchingSecurityPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createMatchingSecurity the Document.","plainTextDescription":"Could not createMatchingSecurity the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"CreateFirstPartyDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not createFirstParty the DocumentType.","plainTextDescription":"Could not createFirstParty the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DeleteDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not delete the Document.","plainTextDescription":"Could not delete the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"The given Document could not be found.","plainTextDescription":"The given Document could not be found.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeAlreadyExists"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"This Document Type Name already exists for the given ontology.\n","plainTextDescription":"This Document Type Name already exists for the given ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNameNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.\n","plainTextDescription":"The Document Type Name does not exist, or the user does not have permission to view the Document Type.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotCompassBacked"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.\n","plainTextDescription":"Creating a hidden child document or a document matching another document's security is only supported\nfor Compass-backed Document Types.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"DocumentTypeNotFound"},"errorType":"NOT_FOUND","parameters":{"documentTypeRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeRid"}}},"safety":"SAFE","documentation":{"example":["ri.backpack..document-type.12345"]}}},"documentation":{"description":"The given DocumentType could not be found.","plainTextDescription":"The given DocumentType could not be found.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"GetOperationalVersionDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not getOperationalVersion the DocumentType.","plainTextDescription":"Could not getOperationalVersion the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidChildDocumentParent"},"errorType":"INVALID_ARGUMENT","parameters":{"parentResourceRid":{"type":{"type":"builtin","builtin":{"type":"rid","rid":{}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"A child document's parent must be a folder or another document.\n","plainTextDescription":"A child document's parent must be a folder or another document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentName"},"errorType":"INVALID_ARGUMENT","parameters":{},"documentation":{"description":"The provided document name must not be empty or consist only of whitespace.\n","plainTextDescription":"The provided document name must not be empty or consist only of whitespace.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeName"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Name is invalid. First-party document type names must follow the format\n`com.palantir.pack..`.\n","plainTextDescription":"The provided Document Type Name is invalid. First-party document type names must follow the format\ncom.palantir.pack...","example":[]}},{"locator":{"namespaceName":"Pack","localName":"InvalidDocumentTypeVersion"},"errorType":"INVALID_ARGUMENT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}},"version":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"SchemaVersion"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided Document Type Version is invalid. The version must be a positive integer.\n","plainTextDescription":"The provided Document Type Version is invalid. The version must be a positive integer.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"LoadByNameDocumentTypesPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not loadByName the DocumentType.","plainTextDescription":"Could not loadByName the DocumentType.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForDocumentNotFound"},"errorType":"NOT_FOUND","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.\n","plainTextDescription":"The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe document could not be resolved to a namespace; when namespaceRid is present, that namespace could not\nbe resolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"NamespaceOrOntologyForFolderNotFound"},"errorType":"NOT_FOUND","parameters":{"folderRid":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Filesystem","localName":"FolderRid"}}},"safety":"SAFE","documentation":{"example":[]}},"namespaceRid":{"type":{"type":"optional","optional":{"subType":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"NamespaceRid"}}}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.\n","plainTextDescription":"The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent,\nthe folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be\nresolved to an ontology.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"ResolveApplicationDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not resolveApplication the Document.","plainTextDescription":"Could not resolveApplication the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SchemaUpdateConflict"},"errorType":"CONFLICT","parameters":{"documentTypeName":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentTypeName"}}},"safety":"UNSAFE","documentation":{"example":[]}}},"documentation":{"description":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.\n","plainTextDescription":"The schema update could not be applied because another update was applied concurrently.\nRetry the operation with the latest schema version.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"SearchDocumentsPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not search the Document.","plainTextDescription":"Could not search the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentNotSupported"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":[]}}},"documentation":{"description":"The user does not have permission to update this document, or the document does not exist.\n","plainTextDescription":"The user does not have permission to update this document, or the document does not exist.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateDocumentPermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{"documentId":{"type":{"type":"reference","reference":{"locator":{"namespaceName":"Pack","localName":"DocumentRid"}}},"safety":"SAFE","documentation":{"example":["ri.gotham-artifact.0-1.document.12345"]}}},"documentation":{"description":"Could not update the Document.","plainTextDescription":"Could not update the Document.","example":[]}},{"locator":{"namespaceName":"Pack","localName":"UpdateSchemaDocumentTypePermissionDenied"},"errorType":"PERMISSION_DENIED","parameters":{},"documentation":{"description":"Could not updateSchema the DocumentType.","plainTextDescription":"Could not updateSchema the DocumentType.","example":[]}}]}; diff --git a/packages/foundry.admin/package.json b/packages/foundry.admin/package.json index 11401fe02..6121bde05 100644 --- a/packages/foundry.admin/package.json +++ b/packages/foundry.admin/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.aipagents/package.json b/packages/foundry.aipagents/package.json index 2e25b8186..9ec2b1f5b 100644 --- a/packages/foundry.aipagents/package.json +++ b/packages/foundry.aipagents/package.json @@ -57,7 +57,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.audit/package.json b/packages/foundry.audit/package.json index ad54b82f1..f3d4441dc 100644 --- a/packages/foundry.audit/package.json +++ b/packages/foundry.audit/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.checkpoints/package.json b/packages/foundry.checkpoints/package.json index 6d10f6dd3..05819f329 100644 --- a/packages/foundry.checkpoints/package.json +++ b/packages/foundry.checkpoints/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.connectivity/package.json b/packages/foundry.connectivity/package.json index c0749114d..bc0e0fd70 100644 --- a/packages/foundry.connectivity/package.json +++ b/packages/foundry.connectivity/package.json @@ -56,7 +56,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.core/package.json b/packages/foundry.core/package.json index c88027911..f4305d296 100644 --- a/packages/foundry.core/package.json +++ b/packages/foundry.core/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.datahealth/package.json b/packages/foundry.datahealth/package.json index 1954cd9c0..2ff367ddf 100644 --- a/packages/foundry.datahealth/package.json +++ b/packages/foundry.datahealth/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.datasets/package.json b/packages/foundry.datasets/package.json index 9a291cf22..3a794aff5 100644 --- a/packages/foundry.datasets/package.json +++ b/packages/foundry.datasets/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.filesystem/package.json b/packages/foundry.filesystem/package.json index 52c91de82..56d2fe381 100644 --- a/packages/foundry.filesystem/package.json +++ b/packages/foundry.filesystem/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.functions/package.json b/packages/foundry.functions/package.json index 93e69a138..0d1d2fca2 100644 --- a/packages/foundry.functions/package.json +++ b/packages/foundry.functions/package.json @@ -54,7 +54,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.geo/package.json b/packages/foundry.geo/package.json index f8ed35cf2..ff113e591 100644 --- a/packages/foundry.geo/package.json +++ b/packages/foundry.geo/package.json @@ -52,7 +52,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.languagemodels/package.json b/packages/foundry.languagemodels/package.json index 9d3f29477..43cd4a372 100644 --- a/packages/foundry.languagemodels/package.json +++ b/packages/foundry.languagemodels/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.mediasets/package.json b/packages/foundry.mediasets/package.json index 3d69edc97..9f1a2750a 100644 --- a/packages/foundry.mediasets/package.json +++ b/packages/foundry.mediasets/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.mediasets/src/_components.ts b/packages/foundry.mediasets/src/_components.ts index e05574d4b..1e38862cf 100644 --- a/packages/foundry.mediasets/src/_components.ts +++ b/packages/foundry.mediasets/src/_components.ts @@ -1417,6 +1417,7 @@ export type MediaSchema = | "MULTIMODAL" | "SPREADSHEET" | "STREAMING_VIDEO" + | "TILED_RASTER" | "VIDEO" | "EMAIL"; @@ -2060,7 +2061,7 @@ export interface SlicePdfRangeOperation { * * Log Safety: SAFE */ -export type SpreadsheetDecodeFormat = "XLSX"; +export type SpreadsheetDecodeFormat = "CSV" | "XLSX"; /** * Metadata for spreadsheet media items. diff --git a/packages/foundry.models/package.json b/packages/foundry.models/package.json index ef14ee3cd..3c0cb4a26 100644 --- a/packages/foundry.models/package.json +++ b/packages/foundry.models/package.json @@ -56,7 +56,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.notepad/package.json b/packages/foundry.notepad/package.json index b02c7d861..5c8c30d3f 100644 --- a/packages/foundry.notepad/package.json +++ b/packages/foundry.notepad/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.ontologies/package.json b/packages/foundry.ontologies/package.json index 882d9a4c4..e400707f4 100644 --- a/packages/foundry.ontologies/package.json +++ b/packages/foundry.ontologies/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.ontologies/src/_components.ts b/packages/foundry.ontologies/src/_components.ts index 1c8fe5403..4b8e67618 100644 --- a/packages/foundry.ontologies/src/_components.ts +++ b/packages/foundry.ontologies/src/_components.ts @@ -117,6 +117,7 @@ export type ActionParameterType = | ({ type: "objectSet" } & OntologyObjectSetType) | ({ type: "geohash" } & _Core.GeohashType) | ({ type: "vector" } & _Core.VectorType) + | ({ type: "decimal" } & _Core.DecimalType) | ({ type: "object" } & OntologyObjectType) | ({ type: "timestamp" } & _Core.TimestampType); diff --git a/packages/foundry.ontologies/src/public/GeotemporalSeriesProperty.ts b/packages/foundry.ontologies/src/public/GeotemporalSeriesProperty.ts index 0ece108c5..05967d83f 100644 --- a/packages/foundry.ontologies/src/public/GeotemporalSeriesProperty.ts +++ b/packages/foundry.ontologies/src/public/GeotemporalSeriesProperty.ts @@ -59,10 +59,10 @@ const _loadGeotemporalSeriesEntries: $FoundryPlatformMethod< * Results are paginated. Use the `nextPageToken` from the response to retrieve subsequent pages. * * :::callout{theme=warning title=Warning} - * Geotemporal series integrations with only "dataset archive" enabled are not supported. + * Geotemporal series integrations with only "cold storage" enabled are not supported. * ::: * - * @alpha + * @beta * * Required Scopes: [api:ontologies-read] * URL: /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/geotemporalSeries/{property}/loadEntries diff --git a/packages/foundry.ontologies/src/public/OntologyInterface.ts b/packages/foundry.ontologies/src/public/OntologyInterface.ts index aec1e05e1..14a2a31c1 100644 --- a/packages/foundry.ontologies/src/public/OntologyInterface.ts +++ b/packages/foundry.ontologies/src/public/OntologyInterface.ts @@ -209,6 +209,11 @@ const _search: $FoundryPlatformMethod< * Attempting to use an unsupported query will result in a validation error. Third-party applications using this * endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. * + * The `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the + * objects in the page are large enough to reach an internal memory limit; this does not indicate + * that there are no more results. As long as the response contains a `nextPageToken`, the remaining + * objects can be retrieved by requesting subsequent pages. + * * @alpha * * Required Scopes: [api:ontologies-read] diff --git a/packages/foundry.ontologies/src/public/OntologyObjectSet.ts b/packages/foundry.ontologies/src/public/OntologyObjectSet.ts index 11660cdc5..c7a287eab 100644 --- a/packages/foundry.ontologies/src/public/OntologyObjectSet.ts +++ b/packages/foundry.ontologies/src/public/OntologyObjectSet.ts @@ -131,6 +131,11 @@ const _load: $FoundryPlatformMethod< * * Vector properties will not be returned unless included in the `select` parameter. * + * The `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the + * objects in the page are large enough to reach an internal memory limit; this does not indicate + * that there are no more results. As long as the response contains a `nextPageToken`, the remaining + * objects can be retrieved by requesting subsequent pages. + * * @public * * Required Scopes: [api:ontologies-read] @@ -193,6 +198,11 @@ const _loadMultipleObjectTypes: $FoundryPlatformMethod< * * Vector properties will not be returned unless included in the `select` parameter. * + * The `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the + * objects in the page are large enough to reach an internal memory limit; this does not indicate + * that there are no more results. As long as the response contains a `nextPageToken`, the remaining + * objects can be retrieved by requesting subsequent pages. + * * @beta * * Required Scopes: [api:ontologies-read] @@ -258,6 +268,11 @@ const _loadObjectsOrInterfaces: $FoundryPlatformMethod< * * Vector properties will not be returned unless included in the `select` parameter. * + * The `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the + * objects in the page are large enough to reach an internal memory limit; this does not indicate + * that there are no more results. As long as the response contains a `nextPageToken`, the remaining + * objects can be retrieved by requesting subsequent pages. + * * @beta * * Required Scopes: [api:ontologies-read] diff --git a/packages/foundry.ontologies/src/public/OntologyObjectV2.ts b/packages/foundry.ontologies/src/public/OntologyObjectV2.ts index 97b977770..93597cc80 100644 --- a/packages/foundry.ontologies/src/public/OntologyObjectV2.ts +++ b/packages/foundry.ontologies/src/public/OntologyObjectV2.ts @@ -208,6 +208,11 @@ const _search: $FoundryPlatformMethod< * Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored. * Partial terms are not matched by terms filters except where explicitly noted. * + * The `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the + * objects in the page are large enough to reach an internal memory limit; this does not indicate + * that there are no more results. As long as the response contains a `nextPageToken`, the remaining + * objects can be retrieved by requesting subsequent pages. + * * @public * * Required Scopes: [api:ontologies-read] diff --git a/packages/foundry.operations/package.json b/packages/foundry.operations/package.json index 13db9b5f1..53111e8fb 100644 --- a/packages/foundry.operations/package.json +++ b/packages/foundry.operations/package.json @@ -54,7 +54,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.orchestration/package.json b/packages/foundry.orchestration/package.json index 815ea5b8d..b1cad7cbf 100644 --- a/packages/foundry.orchestration/package.json +++ b/packages/foundry.orchestration/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.pack/package.json b/packages/foundry.pack/package.json index dcb08fae0..c7aaa10ef 100644 --- a/packages/foundry.pack/package.json +++ b/packages/foundry.pack/package.json @@ -54,7 +54,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.pack/src/_errors.ts b/packages/foundry.pack/src/_errors.ts index 404f354d4..6168482f7 100644 --- a/packages/foundry.pack/src/_errors.ts +++ b/packages/foundry.pack/src/_errors.ts @@ -316,6 +316,20 @@ export interface InvalidChildDocumentParent { }; } +/** + * The provided document name must not be empty or consist only of whitespace. + * + * Log Safety: SAFE + */ +export interface InvalidDocumentName { + errorCode: "INVALID_ARGUMENT"; + errorName: "InvalidDocumentName"; + errorDescription: + "The provided document name must not be empty or consist only of whitespace."; + errorInstanceId: string; + parameters: {}; +} + /** * The provided Document Type Name is invalid. First-party document type names must follow the format com.palantir.pack... @@ -363,6 +377,44 @@ export interface LoadByNameDocumentTypesPermissionDenied { parameters: {}; } +/** + * The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent, +the document could not be resolved to a namespace; when namespaceRid is present, that namespace could not +be resolved to an ontology. + * + * Log Safety: SAFE + */ +export interface NamespaceOrOntologyForDocumentNotFound { + errorCode: "NOT_FOUND"; + errorName: "NamespaceOrOntologyForDocumentNotFound"; + errorDescription: + "The provided document could not be resolved to a namespace or ontology. When namespaceRid is absent, the document could not be resolved to a namespace; when namespaceRid is present, that namespace could not be resolved to an ontology."; + errorInstanceId: string; + parameters: { + documentId: unknown; + namespaceRid: unknown; + }; +} + +/** + * The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent, +the folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be +resolved to an ontology. + * + * Log Safety: SAFE + */ +export interface NamespaceOrOntologyForFolderNotFound { + errorCode: "NOT_FOUND"; + errorName: "NamespaceOrOntologyForFolderNotFound"; + errorDescription: + "The provided parent folder could not be resolved to a namespace or ontology. When namespaceRid is absent, the folder could not be resolved to a namespace; when namespaceRid is present, that namespace could not be resolved to an ontology."; + errorInstanceId: string; + parameters: { + folderRid: unknown; + namespaceRid: unknown; + }; +} + /** * Could not resolveApplication the Document. * diff --git a/packages/foundry.pack/src/index.ts b/packages/foundry.pack/src/index.ts index b9de262a8..6e7456269 100644 --- a/packages/foundry.pack/src/index.ts +++ b/packages/foundry.pack/src/index.ts @@ -165,9 +165,12 @@ export type { DocumentTypeNotFound, GetOperationalVersionDocumentTypePermissionDenied, InvalidChildDocumentParent, + InvalidDocumentName, InvalidDocumentTypeName, InvalidDocumentTypeVersion, LoadByNameDocumentTypesPermissionDenied, + NamespaceOrOntologyForDocumentNotFound, + NamespaceOrOntologyForFolderNotFound, ResolveApplicationDocumentPermissionDenied, SchemaUpdateConflict, SearchDocumentsPermissionDenied, diff --git a/packages/foundry.publicapis/package.json b/packages/foundry.publicapis/package.json index 30b2e13d3..d36026303 100644 --- a/packages/foundry.publicapis/package.json +++ b/packages/foundry.publicapis/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.sqlqueries/package.json b/packages/foundry.sqlqueries/package.json index bdbd15cfa..562aa8a64 100644 --- a/packages/foundry.sqlqueries/package.json +++ b/packages/foundry.sqlqueries/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.streams/package.json b/packages/foundry.streams/package.json index 2b9af6d26..e7e623b09 100644 --- a/packages/foundry.streams/package.json +++ b/packages/foundry.streams/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.thirdpartyapplications/package.json b/packages/foundry.thirdpartyapplications/package.json index 9193e70ee..3d434667b 100644 --- a/packages/foundry.thirdpartyapplications/package.json +++ b/packages/foundry.thirdpartyapplications/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry.widgets/package.json b/packages/foundry.widgets/package.json index 789536101..3c6da7b3e 100644 --- a/packages/foundry.widgets/package.json +++ b/packages/foundry.widgets/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/foundry/package.json b/packages/foundry/package.json index 3c41cc5cc..6cd4d5e71 100644 --- a/packages/foundry/package.json +++ b/packages/foundry/package.json @@ -84,7 +84,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/gotham.core/package.json b/packages/gotham.core/package.json index 413e7f807..ea5ee3b4f 100644 --- a/packages/gotham.core/package.json +++ b/packages/gotham.core/package.json @@ -52,7 +52,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/gotham.gaia/package.json b/packages/gotham.gaia/package.json index 318f307be..ff1703559 100644 --- a/packages/gotham.gaia/package.json +++ b/packages/gotham.gaia/package.json @@ -54,7 +54,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/gotham.geojson/package.json b/packages/gotham.geojson/package.json index 4ac6bd13e..7a854ba8d 100644 --- a/packages/gotham.geojson/package.json +++ b/packages/gotham.geojson/package.json @@ -52,7 +52,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/gotham.maprendering/package.json b/packages/gotham.maprendering/package.json index 6c515c8a2..7cea4d53d 100644 --- a/packages/gotham.maprendering/package.json +++ b/packages/gotham.maprendering/package.json @@ -54,7 +54,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/gotham.targetworkbench/package.json b/packages/gotham.targetworkbench/package.json index c143e6726..1c91b7143 100644 --- a/packages/gotham.targetworkbench/package.json +++ b/packages/gotham.targetworkbench/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/gotham/package.json b/packages/gotham/package.json index 937b72755..010f0e161 100644 --- a/packages/gotham/package.json +++ b/packages/gotham/package.json @@ -57,7 +57,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/internal.foundry.core/package.json b/packages/internal.foundry.core/package.json index 9dd602963..eed59a8db 100644 --- a/packages/internal.foundry.core/package.json +++ b/packages/internal.foundry.core/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/internal.foundry.datasets/package.json b/packages/internal.foundry.datasets/package.json index 276d6a6b0..8a90c0d3a 100644 --- a/packages/internal.foundry.datasets/package.json +++ b/packages/internal.foundry.datasets/package.json @@ -53,7 +53,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/internal.foundry.geo/package.json b/packages/internal.foundry.geo/package.json index d1a88075b..a486af288 100644 --- a/packages/internal.foundry.geo/package.json +++ b/packages/internal.foundry.geo/package.json @@ -52,7 +52,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/internal.foundry.ontologies/package.json b/packages/internal.foundry.ontologies/package.json index 9e5689ad5..24382203e 100644 --- a/packages/internal.foundry.ontologies/package.json +++ b/packages/internal.foundry.ontologies/package.json @@ -55,7 +55,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false } diff --git a/packages/internal.foundry.ontologies/src/_components.ts b/packages/internal.foundry.ontologies/src/_components.ts index 794c9f64c..659f9239d 100644 --- a/packages/internal.foundry.ontologies/src/_components.ts +++ b/packages/internal.foundry.ontologies/src/_components.ts @@ -117,6 +117,7 @@ export type ActionParameterType = | ({ type: "objectSet" } & OntologyObjectSetType) | ({ type: "geohash" } & _Core.GeohashType) | ({ type: "vector" } & _Core.VectorType) + | ({ type: "decimal" } & _Core.DecimalType) | ({ type: "object" } & OntologyObjectType) | ({ type: "timestamp" } & _Core.TimestampType); diff --git a/packages/internal.foundry.ontologies/src/public/OntologyObject.ts b/packages/internal.foundry.ontologies/src/public/OntologyObject.ts index 0f44eadea..2737a499b 100644 --- a/packages/internal.foundry.ontologies/src/public/OntologyObject.ts +++ b/packages/internal.foundry.ontologies/src/public/OntologyObject.ts @@ -236,6 +236,11 @@ const _search: $FoundryPlatformMethod< * Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored. * Partial terms are not matched by terms filters except where explicitly noted. * + * The `pageSize` parameter is a maximum. A page may contain fewer objects than requested if the + * objects in the page are large enough to reach an internal memory limit; this does not indicate + * that there are no more results. As long as the response contains a `nextPageToken`, the remaining + * objects can be retrieved by requesting subsequent pages. + * * @public * * Required Scopes: [api:ontologies-read] diff --git a/packages/internal.foundry/package.json b/packages/internal.foundry/package.json index 8da32e674..6a9dc412c 100644 --- a/packages/internal.foundry/package.json +++ b/packages/internal.foundry/package.json @@ -58,7 +58,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1751.1", + "minVersion": "1.1763.0", "maxVersion": "1.x.x", "optional": false }