From d2f3d95d5b591bbc474fb759cc7159c61c8c5e12 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Mon, 9 Sep 2024 15:52:54 -0300 Subject: [PATCH 1/4] python generate --- scripts/generate_sdk.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/generate_sdk.sh b/scripts/generate_sdk.sh index bb9fa1e85..d6e24c0d8 100755 --- a/scripts/generate_sdk.sh +++ b/scripts/generate_sdk.sh @@ -14,6 +14,7 @@ EXCLUDED_PATHS=( "assets" # Unit tets are written manually "test" + "venv" ) TMP_DIR=$(mktemp -d) @@ -34,7 +35,7 @@ rsync -av "$TMP_DIR/" ./ &> /dev/null # Clean up the temporary directory rm -rf "$TMP_DIR" -foundry_sdk_generator \ +python -m platform_sdk_generator \ --config_path config.json \ --output_dir . \ --manifest_path "tmp/manifest.yml" \ From 43c046cf4f0af58e834d4cb2b8197177ad07fdea Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Thu, 12 Sep 2024 15:08:54 -0300 Subject: [PATCH 2/4] Upgrade API --- README.md | 69 +- docs/v1/models/ActionMode.md | 4 +- docs/v1/models/AggregationAccuracy.md | 3 +- docs/v1/models/AggregationAccuracyRequest.md | 3 +- docs/v1/models/AggregationV2.md | 1 + docs/v1/models/AggregationV2Dict.md | 1 + docs/v1/models/ApplyActionMode.md | 3 +- .../ApproximatePercentileAggregationV2.md | 2 +- .../ApproximatePercentileAggregationV2Dict.md | 2 +- docs/v1/models/ArchiveFileFormat.md | 2 +- docs/v1/models/AsyncActionStatus.md | 8 +- docs/v1/models/ChatCompletionChoice.md | 11 - docs/v1/models/ChatCompletionChoiceDict.md | 11 - docs/v1/models/ChatCompletionRequest.md | 12 - docs/v1/models/ChatCompletionRequestDict.md | 12 - docs/v1/models/ChatCompletionResponse.md | 11 - docs/v1/models/ChatCompletionResponseDict.md | 11 - docs/v1/models/ChatMessage.md | 12 - docs/v1/models/ChatMessageDict.md | 12 - docs/v1/models/ChatMessageRole.md | 10 - docs/v1/models/DistanceUnit.md | 10 +- docs/v1/models/ExactDistinctAggregationV2.md | 14 + .../models/ExactDistinctAggregationV2Dict.md | 14 + .../v1/models/InterfaceLinkTypeCardinality.md | 3 +- docs/v1/models/LanguageModel.md | 12 - docs/v1/models/LanguageModelApiName.md | 13 - docs/v1/models/LanguageModelDict.md | 12 - docs/v1/models/LanguageModelSource.md | 10 - docs/v1/models/LinkTypeSideCardinality.md | 3 +- docs/v1/models/ListLanguageModelsResponse.md | 11 - .../models/ListLanguageModelsResponseDict.md | 11 - .../models/ObjectSetStreamSubscribeRequest.md | 1 - .../ObjectSetStreamSubscribeRequestDict.md | 1 - docs/v1/models/ObjectState.md | 3 +- docs/v1/models/ObjectTypeVisibility.md | 4 +- docs/v1/models/OrderByDirection.md | 3 +- docs/v1/models/ParameterKey.md | 12 - docs/v1/models/ParameterValue.md | 11 - docs/v1/models/ReasonType.md | 3 +- docs/v1/models/ReferenceUpdate.md | 4 +- docs/v1/models/ReferenceUpdateDict.md | 4 +- docs/v1/models/RelativeTimeRelation.md | 3 +- docs/v1/models/RelativeTimeSeriesTimeUnit.md | 9 +- docs/v1/models/ReleaseStatus.md | 4 +- docs/v1/models/ReturnEditsMode.md | 3 +- docs/v1/models/TableExportFormat.md | 3 +- docs/v1/models/TimeUnit.md | 10 +- docs/v1/models/TransactionStatus.md | 4 +- docs/v1/models/TransactionType.md | 5 +- docs/v1/models/ValidationResult.md | 3 +- docs/v1/namespaces/Ontologies/Query.md | 5 - docs/v1/namespaces/Ontologies/QueryType.md | 15 - docs/v2/models/ActionMode.md | 4 +- docs/v2/models/AggregationAccuracy.md | 3 +- docs/v2/models/AggregationAccuracyRequest.md | 3 +- docs/v2/models/AggregationV2.md | 1 + docs/v2/models/AggregationV2Dict.md | 1 + docs/v2/models/ApplyActionMode.md | 3 +- .../ApproximatePercentileAggregationV2.md | 2 +- .../ApproximatePercentileAggregationV2Dict.md | 2 +- docs/v2/models/ArchiveFileFormat.md | 2 +- docs/v2/models/AsyncActionStatus.md | 8 +- docs/v2/models/Build.md | 2 + docs/v2/models/BuildDict.md | 2 + docs/v2/models/BuildStatus.md | 5 +- docs/v2/models/ChatCompletionRequest.md | 12 - docs/v2/models/ChatCompletionRequestDict.md | 12 - docs/v2/models/CreateBuildsRequest.md | 18 + docs/v2/models/CreateBuildsRequestDict.md | 18 + docs/v2/models/DistanceUnit.md | 10 +- docs/v2/models/Duration.md | 2 +- docs/v2/models/DurationDict.md | 2 +- docs/v2/models/ExactDistinctAggregationV2.md | 14 + .../models/ExactDistinctAggregationV2Dict.md | 14 + .../{ChatCompletionChoice.md => Folder.md} | 6 +- ...tCompletionChoiceDict.md => FolderDict.md} | 6 +- docs/v2/models/FolderRid.md | 2 +- .../v2/models/InterfaceLinkTypeCardinality.md | 3 +- docs/v2/models/IrVersion.md | 2 +- docs/v2/models/LanguageModel.md | 12 - docs/v2/models/LanguageModelApiName.md | 13 - docs/v2/models/LanguageModelDict.md | 12 - docs/v2/models/LinkTypeSideCardinality.md | 3 +- docs/v2/models/ListLanguageModelsResponse.md | 11 - .../models/ListLanguageModelsResponseDict.md | 11 - .../models/ObjectSetStreamSubscribeRequest.md | 1 - .../ObjectSetStreamSubscribeRequestDict.md | 1 - docs/v2/models/ObjectState.md | 3 +- docs/v2/models/ObjectTypeVisibility.md | 4 +- docs/v2/models/OrderByDirection.md | 3 +- docs/v2/models/PrincipalFilterType.md | 2 +- docs/v2/models/PrincipalType.md | 3 +- docs/v2/models/{ChatMessage.md => Project.md} | 7 +- .../{ChatMessageDict.md => ProjectDict.md} | 7 +- docs/v2/models/ProjectRid.md | 3 +- docs/v2/models/ReasonType.md | 3 +- docs/v2/models/ReferenceUpdate.md | 4 +- docs/v2/models/ReferenceUpdateDict.md | 4 +- docs/v2/models/RelativeTimeRelation.md | 3 +- docs/v2/models/RelativeTimeSeriesTimeUnit.md | 9 +- docs/v2/models/ReleaseStatus.md | 4 +- docs/v2/models/Resource.md | 24 + docs/v2/models/ResourceDict.md | 24 + ...ParameterKey.md => ResourceDisplayName.md} | 5 +- docs/v2/models/ResourcePath.md | 3 +- ...{LanguageModelSource.md => ResourceRid.md} | 11 +- docs/v2/models/ResourceType.md | 58 + docs/v2/models/ReturnEditsMode.md | 3 +- docs/v2/models/Schedule.md | 2 +- docs/v2/models/ScheduleDict.md | 2 +- docs/v2/models/ScheduleRun.md | 16 + docs/v2/models/ScheduleRunDict.md | 16 + ...ionResponseDict.md => ScheduleRunError.md} | 8 +- ...ionResponse.md => ScheduleRunErrorDict.md} | 8 +- docs/v2/models/ScheduleRunErrorName.md | 16 + docs/v2/models/ScheduleRunIgnored.md | 12 + docs/v2/models/ScheduleRunIgnoredDict.md | 12 + docs/v2/models/ScheduleRunResult.md | 19 + docs/v2/models/ScheduleRunResultDict.md | 19 + .../{ParameterValue.md => ScheduleRunRid.md} | 6 +- docs/v2/models/ScheduleRunSubmitted.md | 12 + docs/v2/models/ScheduleRunSubmittedDict.md | 12 + docs/v2/models/Space.md | 11 + docs/v2/models/SpaceDict.md | 11 + docs/v2/models/SpaceRid.md | 11 + docs/v2/models/TableExportFormat.md | 3 +- docs/v2/models/TimeUnit.md | 9 +- docs/v2/models/TransactionStatus.md | 4 +- docs/v2/models/TransactionType.md | 5 +- .../{ChatMessageRole.md => TrashedStatus.md} | 8 +- docs/v2/models/ValidationResult.md | 3 +- docs/v2/namespaces/Orchestration/Build.md | 61 + docs/v2/namespaces/Orchestration/Schedule.md | 171 + foundry/_core/auth_utils.py | 2 + foundry/_core/foundry_token_auth_client.py | 1 + foundry/_core/page_iterator.py | 3 +- foundry/_versions.py | 2 +- foundry/v1/_namespaces/ontologies/query.py | 5 - .../v1/_namespaces/ontologies/query_type.py | 15 - foundry/v1/cli.py | 12 - foundry/v1/models/__init__.py | 42 +- foundry/v1/models/_aggregation_v2.py | 2 + foundry/v1/models/_aggregation_v2_dict.py | 4 + .../_approximate_percentile_aggregation_v2.py | 2 +- ...roximate_percentile_aggregation_v2_dict.py | 2 +- foundry/v1/models/_chat_completion_request.py | 54 - .../models/_chat_completion_request_dict.py | 48 - .../v1/models/_chat_completion_response.py | 36 - ...e.py => _exact_distinct_aggregation_v2.py} | 28 +- .../_exact_distinct_aggregation_v2_dict.py} | 19 +- .../_object_set_stream_subscribe_request.py | 4 - ...bject_set_stream_subscribe_request_dict.py | 4 - foundry/v1/models/_parameter_value.py | 21 - foundry/v1/models/_reference_update.py | 4 +- foundry/v1/models/_reference_update_dict.py | 4 +- .../_search_objects_for_interface_request.py | 6 +- foundry/v2/_namespaces/orchestration/build.py | 48 + .../v2/_namespaces/orchestration/schedule.py | 132 + foundry/v2/cli.py | 100 + foundry/v2/models/__init__.py | 96 +- foundry/v2/models/_aggregation_v2.py | 2 + foundry/v2/models/_aggregation_v2_dict.py | 4 + .../_approximate_percentile_aggregation_v2.py | 2 +- ...roximate_percentile_aggregation_v2_dict.py | 2 +- foundry/v2/models/_build.py | 7 + foundry/v2/models/_build_dict.py | 7 + foundry/v2/models/_chat_completion_request.py | 54 - .../models/_chat_completion_request_dict.py | 48 - .../v2/models/_chat_completion_response.py | 36 - .../models/_chat_completion_response_dict.py | 30 - foundry/v2/models/_create_builds_request.py | 65 + .../v2/models/_create_builds_request_dict.py | 53 + foundry/v2/models/_duration.py | 4 +- foundry/v2/models/_duration_dict.py | 4 +- ...e.py => _exact_distinct_aggregation_v2.py} | 28 +- .../_exact_distinct_aggregation_v2_dict.py} | 19 +- .../models/_folder.py} | 15 +- .../models/_folder_dict.py} | 9 +- foundry/v2/models/_folder_rid.py | 2 +- foundry/v2/models/_language_model.py | 40 - foundry/v2/models/_language_model_dict.py | 32 - .../_object_set_stream_subscribe_request.py | 4 - ...bject_set_stream_subscribe_request_dict.py | 4 - foundry/v2/models/_parameter_key.py | 21 - ..._chat_completion_choice.py => _project.py} | 15 +- ...letion_choice_dict.py => _project_dict.py} | 9 +- foundry/v2/models/_project_rid.py | 2 +- foundry/v2/models/_reference_update.py | 4 +- foundry/v2/models/_reference_update_dict.py | 4 +- foundry/v2/models/_resource.py | 97 + foundry/v2/models/_resource_dict.py | 89 + .../models/_resource_display_name.py} | 4 +- foundry/v2/models/_resource_path.py | 2 +- .../models/_resource_rid.py} | 6 +- foundry/v2/models/_resource_type.py | 71 + foundry/v2/models/_schedule.py | 2 +- foundry/v2/models/_schedule_dict.py | 2 +- foundry/v2/models/_schedule_run.py | 62 + foundry/v2/models/_schedule_run_dict.py | 54 + .../models/_schedule_run_error.py} | 22 +- .../models/_schedule_run_error_dict.py} | 15 +- ..._source.py => _schedule_run_error_name.py} | 12 +- .../models/_schedule_run_ignored.py} | 18 +- ..._dict.py => _schedule_run_ignored_dict.py} | 11 +- ...el_api_name.py => _schedule_run_result.py} | 17 +- .../models/_schedule_run_result_dict.py} | 30 +- ...arameter_value.py => _schedule_run_rid.py} | 6 +- foundry/v2/models/_schedule_run_submitted.py | 39 + .../models/_schedule_run_submitted_dict.py} | 13 +- .../_search_objects_for_interface_request.py | 6 +- .../v2/models/{_chat_message.py => _space.py} | 18 +- .../models/_space_dict.py} | 16 +- .../{_chat_message_role.py => _space_rid.py} | 6 +- foundry/v2/models/_time_unit.py | 2 +- .../models/_trashed_status.py} | 4 +- openapi.yml | 19536 ++++++++-------- scripts/generate_spec.sh | 2 + 217 files changed, 11633 insertions(+), 11041 deletions(-) delete mode 100644 docs/v1/models/ChatCompletionChoice.md delete mode 100644 docs/v1/models/ChatCompletionChoiceDict.md delete mode 100644 docs/v1/models/ChatCompletionRequest.md delete mode 100644 docs/v1/models/ChatCompletionRequestDict.md delete mode 100644 docs/v1/models/ChatCompletionResponse.md delete mode 100644 docs/v1/models/ChatCompletionResponseDict.md delete mode 100644 docs/v1/models/ChatMessage.md delete mode 100644 docs/v1/models/ChatMessageDict.md delete mode 100644 docs/v1/models/ChatMessageRole.md create mode 100644 docs/v1/models/ExactDistinctAggregationV2.md create mode 100644 docs/v1/models/ExactDistinctAggregationV2Dict.md delete mode 100644 docs/v1/models/LanguageModel.md delete mode 100644 docs/v1/models/LanguageModelApiName.md delete mode 100644 docs/v1/models/LanguageModelDict.md delete mode 100644 docs/v1/models/LanguageModelSource.md delete mode 100644 docs/v1/models/ListLanguageModelsResponse.md delete mode 100644 docs/v1/models/ListLanguageModelsResponseDict.md delete mode 100644 docs/v1/models/ParameterKey.md delete mode 100644 docs/v1/models/ParameterValue.md delete mode 100644 docs/v2/models/ChatCompletionRequest.md delete mode 100644 docs/v2/models/ChatCompletionRequestDict.md create mode 100644 docs/v2/models/CreateBuildsRequest.md create mode 100644 docs/v2/models/CreateBuildsRequestDict.md create mode 100644 docs/v2/models/ExactDistinctAggregationV2.md create mode 100644 docs/v2/models/ExactDistinctAggregationV2Dict.md rename docs/v2/models/{ChatCompletionChoice.md => Folder.md} (75%) rename docs/v2/models/{ChatCompletionChoiceDict.md => FolderDict.md} (73%) delete mode 100644 docs/v2/models/LanguageModel.md delete mode 100644 docs/v2/models/LanguageModelApiName.md delete mode 100644 docs/v2/models/LanguageModelDict.md delete mode 100644 docs/v2/models/ListLanguageModelsResponse.md delete mode 100644 docs/v2/models/ListLanguageModelsResponseDict.md rename docs/v2/models/{ChatMessage.md => Project.md} (71%) rename docs/v2/models/{ChatMessageDict.md => ProjectDict.md} (70%) create mode 100644 docs/v2/models/Resource.md create mode 100644 docs/v2/models/ResourceDict.md rename docs/v2/models/{ParameterKey.md => ResourceDisplayName.md} (75%) rename docs/v2/models/{LanguageModelSource.md => ResourceRid.md} (58%) create mode 100644 docs/v2/models/ResourceType.md create mode 100644 docs/v2/models/ScheduleRun.md create mode 100644 docs/v2/models/ScheduleRunDict.md rename docs/v2/models/{ChatCompletionResponseDict.md => ScheduleRunError.md} (57%) rename docs/v2/models/{ChatCompletionResponse.md => ScheduleRunErrorDict.md} (57%) create mode 100644 docs/v2/models/ScheduleRunErrorName.md create mode 100644 docs/v2/models/ScheduleRunIgnored.md create mode 100644 docs/v2/models/ScheduleRunIgnoredDict.md create mode 100644 docs/v2/models/ScheduleRunResult.md create mode 100644 docs/v2/models/ScheduleRunResultDict.md rename docs/v2/models/{ParameterValue.md => ScheduleRunRid.md} (79%) create mode 100644 docs/v2/models/ScheduleRunSubmitted.md create mode 100644 docs/v2/models/ScheduleRunSubmittedDict.md create mode 100644 docs/v2/models/Space.md create mode 100644 docs/v2/models/SpaceDict.md create mode 100644 docs/v2/models/SpaceRid.md rename docs/v2/models/{ChatMessageRole.md => TrashedStatus.md} (64%) delete mode 100644 foundry/v1/models/_chat_completion_request.py delete mode 100644 foundry/v1/models/_chat_completion_request_dict.py delete mode 100644 foundry/v1/models/_chat_completion_response.py rename foundry/v1/models/{_list_language_models_response.py => _exact_distinct_aggregation_v2.py} (51%) rename foundry/{v2/models/_chat_message_dict.py => v1/models/_exact_distinct_aggregation_v2_dict.py} (56%) delete mode 100644 foundry/v1/models/_parameter_value.py delete mode 100644 foundry/v2/models/_chat_completion_request.py delete mode 100644 foundry/v2/models/_chat_completion_request_dict.py delete mode 100644 foundry/v2/models/_chat_completion_response.py delete mode 100644 foundry/v2/models/_chat_completion_response_dict.py create mode 100644 foundry/v2/models/_create_builds_request.py create mode 100644 foundry/v2/models/_create_builds_request_dict.py rename foundry/v2/models/{_list_language_models_response.py => _exact_distinct_aggregation_v2.py} (51%) rename foundry/{v1/models/_language_model_dict.py => v2/models/_exact_distinct_aggregation_v2_dict.py} (56%) rename foundry/{v1/models/_chat_completion_choice.py => v2/models/_folder.py} (65%) rename foundry/{v1/models/_chat_completion_choice_dict.py => v2/models/_folder_dict.py} (76%) delete mode 100644 foundry/v2/models/_language_model.py delete mode 100644 foundry/v2/models/_language_model_dict.py delete mode 100644 foundry/v2/models/_parameter_key.py rename foundry/v2/models/{_chat_completion_choice.py => _project.py} (65%) rename foundry/v2/models/{_chat_completion_choice_dict.py => _project_dict.py} (76%) create mode 100644 foundry/v2/models/_resource.py create mode 100644 foundry/v2/models/_resource_dict.py rename foundry/{v1/models/_parameter_key.py => v2/models/_resource_display_name.py} (89%) rename foundry/{v1/models/_language_model_source.py => v2/models/_resource_rid.py} (85%) create mode 100644 foundry/v2/models/_resource_type.py create mode 100644 foundry/v2/models/_schedule_run.py create mode 100644 foundry/v2/models/_schedule_run_dict.py rename foundry/{v1/models/_language_model.py => v2/models/_schedule_run_error.py} (59%) rename foundry/{v1/models/_chat_message_dict.py => v2/models/_schedule_run_error_dict.py} (72%) rename foundry/v2/models/{_language_model_source.py => _schedule_run_error_name.py} (73%) rename foundry/{v1/models/_chat_message.py => v2/models/_schedule_run_ignored.py} (65%) rename foundry/v2/models/{_list_language_models_response_dict.py => _schedule_run_ignored_dict.py} (74%) rename foundry/v2/models/{_language_model_api_name.py => _schedule_run_result.py} (52%) rename foundry/{v1/models/_chat_completion_response_dict.py => v2/models/_schedule_run_result_dict.py} (50%) rename foundry/v2/models/{_parameter_value.py => _schedule_run_rid.py} (87%) create mode 100644 foundry/v2/models/_schedule_run_submitted.py rename foundry/{v1/models/_list_language_models_response_dict.py => v2/models/_schedule_run_submitted_dict.py} (74%) rename foundry/v2/models/{_chat_message.py => _space.py} (65%) rename foundry/{v1/models/_language_model_api_name.py => v2/models/_space_dict.py} (74%) rename foundry/v2/models/{_chat_message_role.py => _space_rid.py} (85%) rename foundry/{v1/models/_chat_message_role.py => v2/models/_trashed_status.py} (87%) diff --git a/README.md b/README.md index 90632075a..b71b9ef62 100644 --- a/README.md +++ b/README.md @@ -388,8 +388,12 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | TimeSeriesPropertyV2 | [**get_first_point**](docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md#get_first_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint | **Ontologies** | TimeSeriesPropertyV2 | [**get_last_point**](docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md#get_last_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint | **Ontologies** | TimeSeriesPropertyV2 | [**stream_points**](docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md#stream_points) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints | +**Orchestration** | Build | [**create**](docs/v2/namespaces/Orchestration/Build.md#create) | **POST** /v2/orchestration/builds/create | **Orchestration** | Build | [**get**](docs/v2/namespaces/Orchestration/Build.md#get) | **GET** /v2/orchestration/builds/{buildRid} | **Orchestration** | Schedule | [**get**](docs/v2/namespaces/Orchestration/Schedule.md#get) | **GET** /v2/orchestration/schedules/{scheduleRid} | +**Orchestration** | Schedule | [**pause**](docs/v2/namespaces/Orchestration/Schedule.md#pause) | **POST** /v2/orchestration/schedules/{scheduleRid}/pause | +**Orchestration** | Schedule | [**run**](docs/v2/namespaces/Orchestration/Schedule.md#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | +**Orchestration** | Schedule | [**unpause**](docs/v2/namespaces/Orchestration/Schedule.md#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | **ThirdPartyApplications** | ThirdPartyApplication | [**get**](docs/v2/namespaces/ThirdPartyApplications/ThirdPartyApplication.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid} | **ThirdPartyApplications** | Version | [**delete**](docs/v2/namespaces/ThirdPartyApplications/Version.md#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | **ThirdPartyApplications** | Version | [**get**](docs/v2/namespaces/ThirdPartyApplications/Version.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | @@ -645,15 +649,6 @@ Namespace | Resource | Operation | HTTP request | - [CenterPointDict](docs/v2/models/CenterPointDict.md) - [CenterPointTypes](docs/v2/models/CenterPointTypes.md) - [CenterPointTypesDict](docs/v2/models/CenterPointTypesDict.md) -- [ChatCompletionChoice](docs/v2/models/ChatCompletionChoice.md) -- [ChatCompletionChoiceDict](docs/v2/models/ChatCompletionChoiceDict.md) -- [ChatCompletionRequest](docs/v2/models/ChatCompletionRequest.md) -- [ChatCompletionRequestDict](docs/v2/models/ChatCompletionRequestDict.md) -- [ChatCompletionResponse](docs/v2/models/ChatCompletionResponse.md) -- [ChatCompletionResponseDict](docs/v2/models/ChatCompletionResponseDict.md) -- [ChatMessage](docs/v2/models/ChatMessage.md) -- [ChatMessageDict](docs/v2/models/ChatMessageDict.md) -- [ChatMessageRole](docs/v2/models/ChatMessageRole.md) - [ConnectingTarget](docs/v2/models/ConnectingTarget.md) - [ConnectingTargetDict](docs/v2/models/ConnectingTargetDict.md) - [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/models/ContainsAllTermsInOrderPrefixLastTerm.md) @@ -679,6 +674,8 @@ Namespace | Resource | Operation | HTTP request | - [CountObjectsResponseV2Dict](docs/v2/models/CountObjectsResponseV2Dict.md) - [CreateBranchRequest](docs/v2/models/CreateBranchRequest.md) - [CreateBranchRequestDict](docs/v2/models/CreateBranchRequestDict.md) +- [CreateBuildsRequest](docs/v2/models/CreateBuildsRequest.md) +- [CreateBuildsRequestDict](docs/v2/models/CreateBuildsRequestDict.md) - [CreateDatasetRequest](docs/v2/models/CreateDatasetRequest.md) - [CreateDatasetRequestDict](docs/v2/models/CreateDatasetRequestDict.md) - [CreatedBy](docs/v2/models/CreatedBy.md) @@ -733,6 +730,8 @@ Namespace | Resource | Operation | HTTP request | - [Error](docs/v2/models/Error.md) - [ErrorDict](docs/v2/models/ErrorDict.md) - [ErrorName](docs/v2/models/ErrorName.md) +- [ExactDistinctAggregationV2](docs/v2/models/ExactDistinctAggregationV2.md) +- [ExactDistinctAggregationV2Dict](docs/v2/models/ExactDistinctAggregationV2Dict.md) - [ExecuteQueryRequest](docs/v2/models/ExecuteQueryRequest.md) - [ExecuteQueryRequestDict](docs/v2/models/ExecuteQueryRequestDict.md) - [ExecuteQueryResponse](docs/v2/models/ExecuteQueryResponse.md) @@ -756,6 +755,8 @@ Namespace | Resource | Operation | HTTP request | - [FilterValue](docs/v2/models/FilterValue.md) - [FloatType](docs/v2/models/FloatType.md) - [FloatTypeDict](docs/v2/models/FloatTypeDict.md) +- [Folder](docs/v2/models/Folder.md) +- [FolderDict](docs/v2/models/FolderDict.md) - [FolderRid](docs/v2/models/FolderRid.md) - [ForceBuild](docs/v2/models/ForceBuild.md) - [FunctionRid](docs/v2/models/FunctionRid.md) @@ -830,10 +831,6 @@ Namespace | Resource | Operation | HTTP request | - [IsNullQueryV2Dict](docs/v2/models/IsNullQueryV2Dict.md) - [JobSucceededTrigger](docs/v2/models/JobSucceededTrigger.md) - [JobSucceededTriggerDict](docs/v2/models/JobSucceededTriggerDict.md) -- [LanguageModel](docs/v2/models/LanguageModel.md) -- [LanguageModelApiName](docs/v2/models/LanguageModelApiName.md) -- [LanguageModelDict](docs/v2/models/LanguageModelDict.md) -- [LanguageModelSource](docs/v2/models/LanguageModelSource.md) - [LinearRing](docs/v2/models/LinearRing.md) - [LineString](docs/v2/models/LineString.md) - [LineStringCoordinates](docs/v2/models/LineStringCoordinates.md) @@ -869,8 +866,6 @@ Namespace | Resource | Operation | HTTP request | - [ListGroupsResponseDict](docs/v2/models/ListGroupsResponseDict.md) - [ListInterfaceTypesResponse](docs/v2/models/ListInterfaceTypesResponse.md) - [ListInterfaceTypesResponseDict](docs/v2/models/ListInterfaceTypesResponseDict.md) -- [ListLanguageModelsResponse](docs/v2/models/ListLanguageModelsResponse.md) -- [ListLanguageModelsResponseDict](docs/v2/models/ListLanguageModelsResponseDict.md) - [ListLinkedObjectsResponse](docs/v2/models/ListLinkedObjectsResponse.md) - [ListLinkedObjectsResponseDict](docs/v2/models/ListLinkedObjectsResponseDict.md) - [ListLinkedObjectsResponseV2](docs/v2/models/ListLinkedObjectsResponseV2.md) @@ -1063,10 +1058,8 @@ Namespace | Resource | Operation | HTTP request | - [ParameterEvaluationResult](docs/v2/models/ParameterEvaluationResult.md) - [ParameterEvaluationResultDict](docs/v2/models/ParameterEvaluationResultDict.md) - [ParameterId](docs/v2/models/ParameterId.md) -- [ParameterKey](docs/v2/models/ParameterKey.md) - [ParameterOption](docs/v2/models/ParameterOption.md) - [ParameterOptionDict](docs/v2/models/ParameterOptionDict.md) -- [ParameterValue](docs/v2/models/ParameterValue.md) - [PhraseQuery](docs/v2/models/PhraseQuery.md) - [PhraseQueryDict](docs/v2/models/PhraseQueryDict.md) - [Polygon](docs/v2/models/Polygon.md) @@ -1081,6 +1074,8 @@ Namespace | Resource | Operation | HTTP request | - [PrincipalFilterType](docs/v2/models/PrincipalFilterType.md) - [PrincipalId](docs/v2/models/PrincipalId.md) - [PrincipalType](docs/v2/models/PrincipalType.md) +- [Project](docs/v2/models/Project.md) +- [ProjectDict](docs/v2/models/ProjectDict.md) - [ProjectRid](docs/v2/models/ProjectRid.md) - [ProjectScope](docs/v2/models/ProjectScope.md) - [ProjectScopeDict](docs/v2/models/ProjectScopeDict.md) @@ -1155,7 +1150,12 @@ Namespace | Resource | Operation | HTTP request | - [RemoveGroupMembersRequest](docs/v2/models/RemoveGroupMembersRequest.md) - [RemoveGroupMembersRequestDict](docs/v2/models/RemoveGroupMembersRequestDict.md) - [RequestId](docs/v2/models/RequestId.md) +- [Resource](docs/v2/models/Resource.md) +- [ResourceDict](docs/v2/models/ResourceDict.md) +- [ResourceDisplayName](docs/v2/models/ResourceDisplayName.md) - [ResourcePath](docs/v2/models/ResourcePath.md) +- [ResourceRid](docs/v2/models/ResourceRid.md) +- [ResourceType](docs/v2/models/ResourceType.md) - [RetryBackoffDuration](docs/v2/models/RetryBackoffDuration.md) - [RetryBackoffDurationDict](docs/v2/models/RetryBackoffDurationDict.md) - [RetryCount](docs/v2/models/RetryCount.md) @@ -1164,6 +1164,18 @@ Namespace | Resource | Operation | HTTP request | - [ScheduleDict](docs/v2/models/ScheduleDict.md) - [SchedulePaused](docs/v2/models/SchedulePaused.md) - [ScheduleRid](docs/v2/models/ScheduleRid.md) +- [ScheduleRun](docs/v2/models/ScheduleRun.md) +- [ScheduleRunDict](docs/v2/models/ScheduleRunDict.md) +- [ScheduleRunError](docs/v2/models/ScheduleRunError.md) +- [ScheduleRunErrorDict](docs/v2/models/ScheduleRunErrorDict.md) +- [ScheduleRunErrorName](docs/v2/models/ScheduleRunErrorName.md) +- [ScheduleRunIgnored](docs/v2/models/ScheduleRunIgnored.md) +- [ScheduleRunIgnoredDict](docs/v2/models/ScheduleRunIgnoredDict.md) +- [ScheduleRunResult](docs/v2/models/ScheduleRunResult.md) +- [ScheduleRunResultDict](docs/v2/models/ScheduleRunResultDict.md) +- [ScheduleRunRid](docs/v2/models/ScheduleRunRid.md) +- [ScheduleRunSubmitted](docs/v2/models/ScheduleRunSubmitted.md) +- [ScheduleRunSubmittedDict](docs/v2/models/ScheduleRunSubmittedDict.md) - [ScheduleSucceededTrigger](docs/v2/models/ScheduleSucceededTrigger.md) - [ScheduleSucceededTriggerDict](docs/v2/models/ScheduleSucceededTriggerDict.md) - [ScheduleVersion](docs/v2/models/ScheduleVersion.md) @@ -1210,6 +1222,9 @@ Namespace | Resource | Operation | HTTP request | - [ShortType](docs/v2/models/ShortType.md) - [ShortTypeDict](docs/v2/models/ShortTypeDict.md) - [SizeBytes](docs/v2/models/SizeBytes.md) +- [Space](docs/v2/models/Space.md) +- [SpaceDict](docs/v2/models/SpaceDict.md) +- [SpaceRid](docs/v2/models/SpaceRid.md) - [StartsWithQuery](docs/v2/models/StartsWithQuery.md) - [StartsWithQueryDict](docs/v2/models/StartsWithQueryDict.md) - [StreamMessage](docs/v2/models/StreamMessage.md) @@ -1269,6 +1284,7 @@ Namespace | Resource | Operation | HTTP request | - [TransactionRid](docs/v2/models/TransactionRid.md) - [TransactionStatus](docs/v2/models/TransactionStatus.md) - [TransactionType](docs/v2/models/TransactionType.md) +- [TrashedStatus](docs/v2/models/TrashedStatus.md) - [Trigger](docs/v2/models/Trigger.md) - [TriggerDict](docs/v2/models/TriggerDict.md) - [TwoDimensionalAggregation](docs/v2/models/TwoDimensionalAggregation.md) @@ -1481,15 +1497,6 @@ Namespace | Resource | Operation | HTTP request | - [CenterPointDict](docs/v1/models/CenterPointDict.md) - [CenterPointTypes](docs/v1/models/CenterPointTypes.md) - [CenterPointTypesDict](docs/v1/models/CenterPointTypesDict.md) -- [ChatCompletionChoice](docs/v1/models/ChatCompletionChoice.md) -- [ChatCompletionChoiceDict](docs/v1/models/ChatCompletionChoiceDict.md) -- [ChatCompletionRequest](docs/v1/models/ChatCompletionRequest.md) -- [ChatCompletionRequestDict](docs/v1/models/ChatCompletionRequestDict.md) -- [ChatCompletionResponse](docs/v1/models/ChatCompletionResponse.md) -- [ChatCompletionResponseDict](docs/v1/models/ChatCompletionResponseDict.md) -- [ChatMessage](docs/v1/models/ChatMessage.md) -- [ChatMessageDict](docs/v1/models/ChatMessageDict.md) -- [ChatMessageRole](docs/v1/models/ChatMessageRole.md) - [ContainsAllTermsInOrderPrefixLastTerm](docs/v1/models/ContainsAllTermsInOrderPrefixLastTerm.md) - [ContainsAllTermsInOrderPrefixLastTermDict](docs/v1/models/ContainsAllTermsInOrderPrefixLastTermDict.md) - [ContainsAllTermsInOrderQuery](docs/v1/models/ContainsAllTermsInOrderQuery.md) @@ -1558,6 +1565,8 @@ Namespace | Resource | Operation | HTTP request | - [Error](docs/v1/models/Error.md) - [ErrorDict](docs/v1/models/ErrorDict.md) - [ErrorName](docs/v1/models/ErrorName.md) +- [ExactDistinctAggregationV2](docs/v1/models/ExactDistinctAggregationV2.md) +- [ExactDistinctAggregationV2Dict](docs/v1/models/ExactDistinctAggregationV2Dict.md) - [ExecuteQueryRequest](docs/v1/models/ExecuteQueryRequest.md) - [ExecuteQueryRequestDict](docs/v1/models/ExecuteQueryRequestDict.md) - [ExecuteQueryResponse](docs/v1/models/ExecuteQueryResponse.md) @@ -1631,10 +1640,6 @@ Namespace | Resource | Operation | HTTP request | - [IsNullQueryDict](docs/v1/models/IsNullQueryDict.md) - [IsNullQueryV2](docs/v1/models/IsNullQueryV2.md) - [IsNullQueryV2Dict](docs/v1/models/IsNullQueryV2Dict.md) -- [LanguageModel](docs/v1/models/LanguageModel.md) -- [LanguageModelApiName](docs/v1/models/LanguageModelApiName.md) -- [LanguageModelDict](docs/v1/models/LanguageModelDict.md) -- [LanguageModelSource](docs/v1/models/LanguageModelSource.md) - [LinearRing](docs/v1/models/LinearRing.md) - [LineString](docs/v1/models/LineString.md) - [LineStringCoordinates](docs/v1/models/LineStringCoordinates.md) @@ -1664,8 +1669,6 @@ Namespace | Resource | Operation | HTTP request | - [ListFilesResponseDict](docs/v1/models/ListFilesResponseDict.md) - [ListInterfaceTypesResponse](docs/v1/models/ListInterfaceTypesResponse.md) - [ListInterfaceTypesResponseDict](docs/v1/models/ListInterfaceTypesResponseDict.md) -- [ListLanguageModelsResponse](docs/v1/models/ListLanguageModelsResponse.md) -- [ListLanguageModelsResponseDict](docs/v1/models/ListLanguageModelsResponseDict.md) - [ListLinkedObjectsResponse](docs/v1/models/ListLinkedObjectsResponse.md) - [ListLinkedObjectsResponseDict](docs/v1/models/ListLinkedObjectsResponseDict.md) - [ListLinkedObjectsResponseV2](docs/v1/models/ListLinkedObjectsResponseV2.md) @@ -1843,10 +1846,8 @@ Namespace | Resource | Operation | HTTP request | - [ParameterEvaluationResult](docs/v1/models/ParameterEvaluationResult.md) - [ParameterEvaluationResultDict](docs/v1/models/ParameterEvaluationResultDict.md) - [ParameterId](docs/v1/models/ParameterId.md) -- [ParameterKey](docs/v1/models/ParameterKey.md) - [ParameterOption](docs/v1/models/ParameterOption.md) - [ParameterOptionDict](docs/v1/models/ParameterOptionDict.md) -- [ParameterValue](docs/v1/models/ParameterValue.md) - [PhraseQuery](docs/v1/models/PhraseQuery.md) - [PhraseQueryDict](docs/v1/models/PhraseQueryDict.md) - [Polygon](docs/v1/models/Polygon.md) diff --git a/docs/v1/models/ActionMode.md b/docs/v1/models/ActionMode.md index bb5f67221..bc82d08aa 100644 --- a/docs/v1/models/ActionMode.md +++ b/docs/v1/models/ActionMode.md @@ -4,7 +4,9 @@ ActionMode | **Value** | | --------- | -| `"('values', ['ASYNC', 'RUN', 'VALIDATE'])"` | +| `"ASYNC"` | +| `"RUN"` | +| `"VALIDATE"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationAccuracy.md b/docs/v1/models/AggregationAccuracy.md index 8eac24570..952865599 100644 --- a/docs/v1/models/AggregationAccuracy.md +++ b/docs/v1/models/AggregationAccuracy.md @@ -4,7 +4,8 @@ AggregationAccuracy | **Value** | | --------- | -| `"('values', ['ACCURATE', 'APPROXIMATE'])"` | +| `"ACCURATE"` | +| `"APPROXIMATE"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationAccuracyRequest.md b/docs/v1/models/AggregationAccuracyRequest.md index e6f2245b0..55dad4b72 100644 --- a/docs/v1/models/AggregationAccuracyRequest.md +++ b/docs/v1/models/AggregationAccuracyRequest.md @@ -4,7 +4,8 @@ AggregationAccuracyRequest | **Value** | | --------- | -| `"('values', ['REQUIRE_ACCURATE', 'ALLOW_APPROXIMATE'])"` | +| `"REQUIRE_ACCURATE"` | +| `"ALLOW_APPROXIMATE"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationV2.md b/docs/v1/models/AggregationV2.md index 2c08d0435..73a2b41b1 100644 --- a/docs/v1/models/AggregationV2.md +++ b/docs/v1/models/AggregationV2.md @@ -16,6 +16,7 @@ This discriminator class uses the `type` field to differentiate between classes. [CountAggregationV2](CountAggregationV2.md) | count [ApproximateDistinctAggregationV2](ApproximateDistinctAggregationV2.md) | approximateDistinct [ApproximatePercentileAggregationV2](ApproximatePercentileAggregationV2.md) | approximatePercentile +[ExactDistinctAggregationV2](ExactDistinctAggregationV2.md) | exactDistinct [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationV2Dict.md b/docs/v1/models/AggregationV2Dict.md index 4f2cc8145..0dea73cdb 100644 --- a/docs/v1/models/AggregationV2Dict.md +++ b/docs/v1/models/AggregationV2Dict.md @@ -16,6 +16,7 @@ This discriminator class uses the `type` field to differentiate between classes. [CountAggregationV2Dict](CountAggregationV2Dict.md) | count [ApproximateDistinctAggregationV2Dict](ApproximateDistinctAggregationV2Dict.md) | approximateDistinct [ApproximatePercentileAggregationV2Dict](ApproximatePercentileAggregationV2Dict.md) | approximatePercentile +[ExactDistinctAggregationV2Dict](ExactDistinctAggregationV2Dict.md) | exactDistinct [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionMode.md b/docs/v1/models/ApplyActionMode.md index 6c8a93853..7fb526460 100644 --- a/docs/v1/models/ApplyActionMode.md +++ b/docs/v1/models/ApplyActionMode.md @@ -4,7 +4,8 @@ ApplyActionMode | **Value** | | --------- | -| `"('values', ['VALIDATE_ONLY', 'VALIDATE_AND_EXECUTE'])"` | +| `"VALIDATE_ONLY"` | +| `"VALIDATE_AND_EXECUTE"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximatePercentileAggregationV2.md b/docs/v1/models/ApproximatePercentileAggregationV2.md index 3f3031d1c..8e35f8af8 100644 --- a/docs/v1/models/ApproximatePercentileAggregationV2.md +++ b/docs/v1/models/ApproximatePercentileAggregationV2.md @@ -1,6 +1,6 @@ # ApproximatePercentileAggregationV2 -Computes the approximate percentile value for the provided field. +Computes the approximate percentile value for the provided field. Requires Object Storage V2. ## Properties | Name | Type | Required | Description | diff --git a/docs/v1/models/ApproximatePercentileAggregationV2Dict.md b/docs/v1/models/ApproximatePercentileAggregationV2Dict.md index bd6161e13..541652541 100644 --- a/docs/v1/models/ApproximatePercentileAggregationV2Dict.md +++ b/docs/v1/models/ApproximatePercentileAggregationV2Dict.md @@ -1,6 +1,6 @@ # ApproximatePercentileAggregationV2Dict -Computes the approximate percentile value for the provided field. +Computes the approximate percentile value for the provided field. Requires Object Storage V2. ## Properties | Name | Type | Required | Description | diff --git a/docs/v1/models/ArchiveFileFormat.md b/docs/v1/models/ArchiveFileFormat.md index 233fb98c6..f60fd990f 100644 --- a/docs/v1/models/ArchiveFileFormat.md +++ b/docs/v1/models/ArchiveFileFormat.md @@ -5,7 +5,7 @@ The format of an archive file. | **Value** | | --------- | -| `"('values', ['ZIP'])"` | +| `"ZIP"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncActionStatus.md b/docs/v1/models/AsyncActionStatus.md index d984fb36a..fd67af365 100644 --- a/docs/v1/models/AsyncActionStatus.md +++ b/docs/v1/models/AsyncActionStatus.md @@ -4,7 +4,13 @@ AsyncActionStatus | **Value** | | --------- | -| `"('values', ['RUNNING_SUBMISSION_CHECKS', 'EXECUTING_WRITE_BACK_WEBHOOK', 'COMPUTING_ONTOLOGY_EDITS', 'COMPUTING_FUNCTION', 'WRITING_ONTOLOGY_EDITS', 'EXECUTING_SIDE_EFFECT_WEBHOOK', 'SENDING_NOTIFICATIONS'])"` | +| `"RUNNING_SUBMISSION_CHECKS"` | +| `"EXECUTING_WRITE_BACK_WEBHOOK"` | +| `"COMPUTING_ONTOLOGY_EDITS"` | +| `"COMPUTING_FUNCTION"` | +| `"WRITING_ONTOLOGY_EDITS"` | +| `"EXECUTING_SIDE_EFFECT_WEBHOOK"` | +| `"SENDING_NOTIFICATIONS"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatCompletionChoice.md b/docs/v1/models/ChatCompletionChoice.md deleted file mode 100644 index fe88e2c63..000000000 --- a/docs/v1/models/ChatCompletionChoice.md +++ /dev/null @@ -1,11 +0,0 @@ -# ChatCompletionChoice - -ChatCompletionChoice - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**message** | Optional[ChatMessage] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatCompletionChoiceDict.md b/docs/v1/models/ChatCompletionChoiceDict.md deleted file mode 100644 index 9515a5042..000000000 --- a/docs/v1/models/ChatCompletionChoiceDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ChatCompletionChoiceDict - -ChatCompletionChoice - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**message** | NotRequired[ChatMessageDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatCompletionRequest.md b/docs/v1/models/ChatCompletionRequest.md deleted file mode 100644 index 8705c3e28..000000000 --- a/docs/v1/models/ChatCompletionRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatCompletionRequest - -ChatCompletionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**messages** | List[ChatMessage] | Yes | | -**parameters** | Dict[ParameterKey, ParameterValue] | Yes | Any additional model-specific parameters: - for global models, the keys can be one of the following (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - `temperature` - `top_p` - `n` - `stop` - `max_tokens` - `presence_penalty` - `frequency_penalty` - `logit_bias` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatCompletionRequestDict.md b/docs/v1/models/ChatCompletionRequestDict.md deleted file mode 100644 index d4f81c3cc..000000000 --- a/docs/v1/models/ChatCompletionRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatCompletionRequestDict - -ChatCompletionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**messages** | List[ChatMessageDict] | Yes | | -**parameters** | Dict[ParameterKey, ParameterValue] | Yes | Any additional model-specific parameters: - for global models, the keys can be one of the following (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - `temperature` - `top_p` - `n` - `stop` - `max_tokens` - `presence_penalty` - `frequency_penalty` - `logit_bias` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatCompletionResponse.md b/docs/v1/models/ChatCompletionResponse.md deleted file mode 100644 index 32b28ee39..000000000 --- a/docs/v1/models/ChatCompletionResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ChatCompletionResponse - -Contains `n` different completion choices as specified in the request parameter. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**choices** | List[ChatCompletionChoice] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatCompletionResponseDict.md b/docs/v1/models/ChatCompletionResponseDict.md deleted file mode 100644 index 01bbdff2c..000000000 --- a/docs/v1/models/ChatCompletionResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ChatCompletionResponseDict - -Contains `n` different completion choices as specified in the request parameter. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**choices** | List[ChatCompletionChoiceDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatMessage.md b/docs/v1/models/ChatMessage.md deleted file mode 100644 index e52e41d3f..000000000 --- a/docs/v1/models/ChatMessage.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatMessage - -ChatMessage - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**role** | ChatMessageRole | Yes | | -**content** | Optional[StrictStr] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatMessageDict.md b/docs/v1/models/ChatMessageDict.md deleted file mode 100644 index 3dbacce21..000000000 --- a/docs/v1/models/ChatMessageDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatMessageDict - -ChatMessage - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**role** | ChatMessageRole | Yes | | -**content** | NotRequired[StrictStr] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ChatMessageRole.md b/docs/v1/models/ChatMessageRole.md deleted file mode 100644 index 39e70befa..000000000 --- a/docs/v1/models/ChatMessageRole.md +++ /dev/null @@ -1,10 +0,0 @@ -# ChatMessageRole - -ChatMessageRole - -| **Value** | -| --------- | -| `"('values', ['SYSTEM', 'ASSISTANT', 'USER'])"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DistanceUnit.md b/docs/v1/models/DistanceUnit.md index 80a0e10cb..8ade626b3 100644 --- a/docs/v1/models/DistanceUnit.md +++ b/docs/v1/models/DistanceUnit.md @@ -4,7 +4,15 @@ DistanceUnit | **Value** | | --------- | -| `"('values', ['MILLIMETERS', 'CENTIMETERS', 'METERS', 'KILOMETERS', 'INCHES', 'FEET', 'YARDS', 'MILES', 'NAUTICAL_MILES'])"` | +| `"MILLIMETERS"` | +| `"CENTIMETERS"` | +| `"METERS"` | +| `"KILOMETERS"` | +| `"INCHES"` | +| `"FEET"` | +| `"YARDS"` | +| `"MILES"` | +| `"NAUTICAL_MILES"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExactDistinctAggregationV2.md b/docs/v1/models/ExactDistinctAggregationV2.md new file mode 100644 index 000000000..8bbb7ce67 --- /dev/null +++ b/docs/v1/models/ExactDistinctAggregationV2.md @@ -0,0 +1,14 @@ +# ExactDistinctAggregationV2 + +Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | Optional[AggregationMetricName] | No | | +**direction** | Optional[OrderByDirection] | No | | +**type** | Literal["exactDistinct"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExactDistinctAggregationV2Dict.md b/docs/v1/models/ExactDistinctAggregationV2Dict.md new file mode 100644 index 000000000..4e0256693 --- /dev/null +++ b/docs/v1/models/ExactDistinctAggregationV2Dict.md @@ -0,0 +1,14 @@ +# ExactDistinctAggregationV2Dict + +Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["exactDistinct"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeCardinality.md b/docs/v1/models/InterfaceLinkTypeCardinality.md index 8b17308fe..095f8206e 100644 --- a/docs/v1/models/InterfaceLinkTypeCardinality.md +++ b/docs/v1/models/InterfaceLinkTypeCardinality.md @@ -6,7 +6,8 @@ link to zero or one other objects, or "MANY", meaning an object can link to any | **Value** | | --------- | -| `"('values', ['ONE', 'MANY'])"` | +| `"ONE"` | +| `"MANY"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LanguageModel.md b/docs/v1/models/LanguageModel.md deleted file mode 100644 index 7d3565c10..000000000 --- a/docs/v1/models/LanguageModel.md +++ /dev/null @@ -1,12 +0,0 @@ -# LanguageModel - -Represents a language model. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | Optional[LanguageModelApiName] | No | | -**source** | Optional[LanguageModelSource] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LanguageModelApiName.md b/docs/v1/models/LanguageModelApiName.md deleted file mode 100644 index bbbc0329f..000000000 --- a/docs/v1/models/LanguageModelApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# LanguageModelApiName - -The name of the language model in the API. To find the API name for your model, use the `List language models` -endpoint. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LanguageModelDict.md b/docs/v1/models/LanguageModelDict.md deleted file mode 100644 index 5838b7aac..000000000 --- a/docs/v1/models/LanguageModelDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LanguageModelDict - -Represents a language model. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | NotRequired[LanguageModelApiName] | No | | -**source** | NotRequired[LanguageModelSource] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LanguageModelSource.md b/docs/v1/models/LanguageModelSource.md deleted file mode 100644 index e6114a883..000000000 --- a/docs/v1/models/LanguageModelSource.md +++ /dev/null @@ -1,10 +0,0 @@ -# LanguageModelSource - -LanguageModelSource - -| **Value** | -| --------- | -| `"('values', ['global', 'hosted'])"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeSideCardinality.md b/docs/v1/models/LinkTypeSideCardinality.md index b1d1061b9..a9ef18763 100644 --- a/docs/v1/models/LinkTypeSideCardinality.md +++ b/docs/v1/models/LinkTypeSideCardinality.md @@ -4,7 +4,8 @@ LinkTypeSideCardinality | **Value** | | --------- | -| `"('values', ['ONE', 'MANY'])"` | +| `"ONE"` | +| `"MANY"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListLanguageModelsResponse.md b/docs/v1/models/ListLanguageModelsResponse.md deleted file mode 100644 index 48387f37f..000000000 --- a/docs/v1/models/ListLanguageModelsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListLanguageModelsResponse - -ListLanguageModelsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[LanguageModel] | Yes | The list of language models. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListLanguageModelsResponseDict.md b/docs/v1/models/ListLanguageModelsResponseDict.md deleted file mode 100644 index a0a63386c..000000000 --- a/docs/v1/models/ListLanguageModelsResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListLanguageModelsResponseDict - -ListLanguageModelsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[LanguageModelDict] | Yes | The list of language models. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStreamSubscribeRequest.md b/docs/v1/models/ObjectSetStreamSubscribeRequest.md index 48163d40b..8db1d5c5e 100644 --- a/docs/v1/models/ObjectSetStreamSubscribeRequest.md +++ b/docs/v1/models/ObjectSetStreamSubscribeRequest.md @@ -5,7 +5,6 @@ ObjectSetStreamSubscribeRequest ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**ontology** | Optional[OntologyIdentifier] | No | | **object_set** | ObjectSet | Yes | | **property_set** | List[SelectedPropertyApiName] | Yes | | **reference_set** | List[SelectedPropertyApiName] | Yes | | diff --git a/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md b/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md index 391f2d693..c7f9f3917 100644 --- a/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md +++ b/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md @@ -5,7 +5,6 @@ ObjectSetStreamSubscribeRequest ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**ontology** | NotRequired[OntologyIdentifier] | No | | **objectSet** | ObjectSetDict | Yes | | **propertySet** | List[SelectedPropertyApiName] | Yes | | **referenceSet** | List[SelectedPropertyApiName] | Yes | | diff --git a/docs/v1/models/ObjectState.md b/docs/v1/models/ObjectState.md index ce80e8373..74ee22002 100644 --- a/docs/v1/models/ObjectState.md +++ b/docs/v1/models/ObjectState.md @@ -8,7 +8,8 @@ definition. | **Value** | | --------- | -| `"('values', ['ADDED_OR_UPDATED', 'REMOVED'])"` | +| `"ADDED_OR_UPDATED"` | +| `"REMOVED"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeVisibility.md b/docs/v1/models/ObjectTypeVisibility.md index 46443fd6f..6b7c9b221 100644 --- a/docs/v1/models/ObjectTypeVisibility.md +++ b/docs/v1/models/ObjectTypeVisibility.md @@ -4,7 +4,9 @@ The suggested visibility of the object type. | **Value** | | --------- | -| `"('values', ['NORMAL', 'PROMINENT', 'HIDDEN'])"` | +| `"NORMAL"` | +| `"PROMINENT"` | +| `"HIDDEN"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrderByDirection.md b/docs/v1/models/OrderByDirection.md index 7b5176a1a..4af3f01bc 100644 --- a/docs/v1/models/OrderByDirection.md +++ b/docs/v1/models/OrderByDirection.md @@ -4,7 +4,8 @@ OrderByDirection | **Value** | | --------- | -| `"('values', ['ASC', 'DESC'])"` | +| `"ASC"` | +| `"DESC"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterKey.md b/docs/v1/models/ParameterKey.md deleted file mode 100644 index 2369c6544..000000000 --- a/docs/v1/models/ParameterKey.md +++ /dev/null @@ -1,12 +0,0 @@ -# ParameterKey - -The unique identifier of the model parameter. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterValue.md b/docs/v1/models/ParameterValue.md deleted file mode 100644 index ec9af1787..000000000 --- a/docs/v1/models/ParameterValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# ParameterValue - -ParameterValue - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReasonType.md b/docs/v1/models/ReasonType.md index 725579e59..898cb3cc1 100644 --- a/docs/v1/models/ReasonType.md +++ b/docs/v1/models/ReasonType.md @@ -5,7 +5,8 @@ Represents the reason a subscription was closed. | **Value** | | --------- | -| `"('values', ['USER_CLOSED', 'CHANNEL_CLOSED'])"` | +| `"USER_CLOSED"` | +| `"CHANNEL_CLOSED"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReferenceUpdate.md b/docs/v1/models/ReferenceUpdate.md index 4f1971bd1..02b4da915 100644 --- a/docs/v1/models/ReferenceUpdate.md +++ b/docs/v1/models/ReferenceUpdate.md @@ -8,9 +8,9 @@ field returns a dereferenced value rather than the reference itself. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | +**object_type** | ObjectTypeApiName | Yes | | **primary_key** | ObjectPrimaryKey | Yes | | -**property_api_name** | PropertyApiName | Yes | | +**property** | PropertyApiName | Yes | | **value** | ReferenceValue | Yes | | **type** | Literal["reference"] | Yes | None | diff --git a/docs/v1/models/ReferenceUpdateDict.md b/docs/v1/models/ReferenceUpdateDict.md index 71832e5b2..02fa17a6d 100644 --- a/docs/v1/models/ReferenceUpdateDict.md +++ b/docs/v1/models/ReferenceUpdateDict.md @@ -8,9 +8,9 @@ field returns a dereferenced value rather than the reference itself. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | +**objectType** | ObjectTypeApiName | Yes | | **primaryKey** | ObjectPrimaryKey | Yes | | -**propertyApiName** | PropertyApiName | Yes | | +**property** | PropertyApiName | Yes | | **value** | ReferenceValueDict | Yes | | **type** | Literal["reference"] | Yes | None | diff --git a/docs/v1/models/RelativeTimeRelation.md b/docs/v1/models/RelativeTimeRelation.md index fb0dfdc82..2f79077b4 100644 --- a/docs/v1/models/RelativeTimeRelation.md +++ b/docs/v1/models/RelativeTimeRelation.md @@ -4,7 +4,8 @@ RelativeTimeRelation | **Value** | | --------- | -| `"('values', ['BEFORE', 'AFTER'])"` | +| `"BEFORE"` | +| `"AFTER"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTimeSeriesTimeUnit.md b/docs/v1/models/RelativeTimeSeriesTimeUnit.md index 2343dbdce..6ce63e025 100644 --- a/docs/v1/models/RelativeTimeSeriesTimeUnit.md +++ b/docs/v1/models/RelativeTimeSeriesTimeUnit.md @@ -4,7 +4,14 @@ RelativeTimeSeriesTimeUnit | **Value** | | --------- | -| `"('values', ['MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS', 'WEEKS', 'MONTHS', 'YEARS'])"` | +| `"MILLISECONDS"` | +| `"SECONDS"` | +| `"MINUTES"` | +| `"HOURS"` | +| `"DAYS"` | +| `"WEEKS"` | +| `"MONTHS"` | +| `"YEARS"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReleaseStatus.md b/docs/v1/models/ReleaseStatus.md index 635448e6d..58dc56fd5 100644 --- a/docs/v1/models/ReleaseStatus.md +++ b/docs/v1/models/ReleaseStatus.md @@ -4,7 +4,9 @@ The release status of the entity. | **Value** | | --------- | -| `"('values', ['ACTIVE', 'EXPERIMENTAL', 'DEPRECATED'])"` | +| `"ACTIVE"` | +| `"EXPERIMENTAL"` | +| `"DEPRECATED"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReturnEditsMode.md b/docs/v1/models/ReturnEditsMode.md index 5073041d7..9d8deddc9 100644 --- a/docs/v1/models/ReturnEditsMode.md +++ b/docs/v1/models/ReturnEditsMode.md @@ -4,7 +4,8 @@ ReturnEditsMode | **Value** | | --------- | -| `"('values', ['ALL', 'NONE'])"` | +| `"ALL"` | +| `"NONE"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TableExportFormat.md b/docs/v1/models/TableExportFormat.md index 8776677f0..eeb5c6f82 100644 --- a/docs/v1/models/TableExportFormat.md +++ b/docs/v1/models/TableExportFormat.md @@ -5,7 +5,8 @@ Format for tabular dataset export. | **Value** | | --------- | -| `"('values', ['ARROW', 'CSV'])"` | +| `"ARROW"` | +| `"CSV"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeUnit.md b/docs/v1/models/TimeUnit.md index a2966203e..8472d9857 100644 --- a/docs/v1/models/TimeUnit.md +++ b/docs/v1/models/TimeUnit.md @@ -4,7 +4,15 @@ TimeUnit | **Value** | | --------- | -| `"('values', ['MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS', 'WEEKS', 'MONTHS', 'YEARS', 'QUARTERS'])"` | +| `"MILLISECONDS"` | +| `"SECONDS"` | +| `"MINUTES"` | +| `"HOURS"` | +| `"DAYS"` | +| `"WEEKS"` | +| `"MONTHS"` | +| `"YEARS"` | +| `"QUARTERS"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TransactionStatus.md b/docs/v1/models/TransactionStatus.md index c4c7222f9..89bba3258 100644 --- a/docs/v1/models/TransactionStatus.md +++ b/docs/v1/models/TransactionStatus.md @@ -5,7 +5,9 @@ The status of a Transaction. | **Value** | | --------- | -| `"('values', ['ABORTED', 'COMMITTED', 'OPEN'])"` | +| `"ABORTED"` | +| `"COMMITTED"` | +| `"OPEN"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TransactionType.md b/docs/v1/models/TransactionType.md index 8bbcf92c2..45768794a 100644 --- a/docs/v1/models/TransactionType.md +++ b/docs/v1/models/TransactionType.md @@ -5,7 +5,10 @@ The type of a Transaction. | **Value** | | --------- | -| `"('values', ['APPEND', 'UPDATE', 'SNAPSHOT', 'DELETE'])"` | +| `"APPEND"` | +| `"UPDATE"` | +| `"SNAPSHOT"` | +| `"DELETE"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidationResult.md b/docs/v1/models/ValidationResult.md index 945f495cd..3736e817c 100644 --- a/docs/v1/models/ValidationResult.md +++ b/docs/v1/models/ValidationResult.md @@ -5,7 +5,8 @@ Represents the state of a validation. | **Value** | | --------- | -| `"('values', ['VALID', 'INVALID'])"` | +| `"VALID"` | +| `"INVALID"` | [[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/namespaces/Ontologies/Query.md b/docs/v1/namespaces/Ontologies/Query.md index 21f94735d..93c2e4dec 100644 --- a/docs/v1/namespaces/Ontologies/Query.md +++ b/docs/v1/namespaces/Ontologies/Query.md @@ -17,7 +17,6 @@ Name | Type | Description | Notes | **ontology_rid** | OntologyRid | ontologyRid | | **query_api_name** | QueryApiName | queryApiName | | **execute_query_request** | Union[ExecuteQueryRequest, ExecuteQueryRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | ### Return type **ExecuteQueryResponse** @@ -42,16 +41,12 @@ query_api_name = "getEmployeesInCity" # Union[ExecuteQueryRequest, ExecuteQueryRequestDict] | Body of the request execute_query_request = {"parameters": {"city": "New York"}} -# Optional[PreviewMode] | preview -preview = true - try: api_response = foundry_client.ontologies.Query.execute( ontology_rid, query_api_name, execute_query_request, - preview=preview, ) print("The execute response:\n") pprint(api_response) diff --git a/docs/v1/namespaces/Ontologies/QueryType.md b/docs/v1/namespaces/Ontologies/QueryType.md index 434cadb7b..d2f396dea 100644 --- a/docs/v1/namespaces/Ontologies/QueryType.md +++ b/docs/v1/namespaces/Ontologies/QueryType.md @@ -18,7 +18,6 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | ontologyRid | | **query_api_name** | QueryApiName | queryApiName | | -**preview** | Optional[PreviewMode] | preview | [optional] | ### Return type **QueryType** @@ -40,15 +39,11 @@ ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" # QueryApiName | queryApiName query_api_name = "getEmployeesInCity" -# Optional[PreviewMode] | preview -preview = true - try: api_response = foundry_client.ontologies.Ontology.QueryType.get( ontology_rid, query_api_name, - preview=preview, ) print("The get response:\n") pprint(api_response) @@ -85,7 +80,6 @@ Name | Type | Description | Notes | ------------- | ------------- | ------------- | ------------- | **ontology_rid** | OntologyRid | ontologyRid | | **page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | ### Return type **ResourceIterator[QueryType]** @@ -107,15 +101,11 @@ ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" # Optional[PageSize] | pageSize page_size = None -# Optional[PreviewMode] | preview -preview = true - try: for query_type in foundry_client.ontologies.Ontology.QueryType.list( ontology_rid, page_size=page_size, - preview=preview, ): pprint(query_type) except PalantirRPCException as e: @@ -152,7 +142,6 @@ Name | Type | Description | Notes | **ontology_rid** | OntologyRid | ontologyRid | | **page_size** | Optional[PageSize] | pageSize | [optional] | **page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | ### Return type **ListQueryTypesResponse** @@ -177,16 +166,12 @@ page_size = None # Optional[PageToken] | pageToken page_token = None -# Optional[PreviewMode] | preview -preview = true - try: api_response = foundry_client.ontologies.Ontology.QueryType.page( ontology_rid, page_size=page_size, page_token=page_token, - preview=preview, ) print("The page response:\n") pprint(api_response) diff --git a/docs/v2/models/ActionMode.md b/docs/v2/models/ActionMode.md index c14f81a5d..e6a6c5b76 100644 --- a/docs/v2/models/ActionMode.md +++ b/docs/v2/models/ActionMode.md @@ -4,7 +4,9 @@ ActionMode | **Value** | | --------- | -| `"('values', ['ASYNC', 'RUN', 'VALIDATE'])"` | +| `"ASYNC"` | +| `"RUN"` | +| `"VALIDATE"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationAccuracy.md b/docs/v2/models/AggregationAccuracy.md index 30d2bc095..70c00e42b 100644 --- a/docs/v2/models/AggregationAccuracy.md +++ b/docs/v2/models/AggregationAccuracy.md @@ -4,7 +4,8 @@ AggregationAccuracy | **Value** | | --------- | -| `"('values', ['ACCURATE', 'APPROXIMATE'])"` | +| `"ACCURATE"` | +| `"APPROXIMATE"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationAccuracyRequest.md b/docs/v2/models/AggregationAccuracyRequest.md index 8112e7d2c..5be402e19 100644 --- a/docs/v2/models/AggregationAccuracyRequest.md +++ b/docs/v2/models/AggregationAccuracyRequest.md @@ -4,7 +4,8 @@ AggregationAccuracyRequest | **Value** | | --------- | -| `"('values', ['REQUIRE_ACCURATE', 'ALLOW_APPROXIMATE'])"` | +| `"REQUIRE_ACCURATE"` | +| `"ALLOW_APPROXIMATE"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationV2.md b/docs/v2/models/AggregationV2.md index 98d9e88a1..0d8194c66 100644 --- a/docs/v2/models/AggregationV2.md +++ b/docs/v2/models/AggregationV2.md @@ -16,6 +16,7 @@ This discriminator class uses the `type` field to differentiate between classes. [CountAggregationV2](CountAggregationV2.md) | count [ApproximateDistinctAggregationV2](ApproximateDistinctAggregationV2.md) | approximateDistinct [ApproximatePercentileAggregationV2](ApproximatePercentileAggregationV2.md) | approximatePercentile +[ExactDistinctAggregationV2](ExactDistinctAggregationV2.md) | exactDistinct [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationV2Dict.md b/docs/v2/models/AggregationV2Dict.md index 1a97156bc..795a6c72f 100644 --- a/docs/v2/models/AggregationV2Dict.md +++ b/docs/v2/models/AggregationV2Dict.md @@ -16,6 +16,7 @@ This discriminator class uses the `type` field to differentiate between classes. [CountAggregationV2Dict](CountAggregationV2Dict.md) | count [ApproximateDistinctAggregationV2Dict](ApproximateDistinctAggregationV2Dict.md) | approximateDistinct [ApproximatePercentileAggregationV2Dict](ApproximatePercentileAggregationV2Dict.md) | approximatePercentile +[ExactDistinctAggregationV2Dict](ExactDistinctAggregationV2Dict.md) | exactDistinct [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionMode.md b/docs/v2/models/ApplyActionMode.md index 55d5ebb9b..aeb8259a4 100644 --- a/docs/v2/models/ApplyActionMode.md +++ b/docs/v2/models/ApplyActionMode.md @@ -4,7 +4,8 @@ ApplyActionMode | **Value** | | --------- | -| `"('values', ['VALIDATE_ONLY', 'VALIDATE_AND_EXECUTE'])"` | +| `"VALIDATE_ONLY"` | +| `"VALIDATE_AND_EXECUTE"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximatePercentileAggregationV2.md b/docs/v2/models/ApproximatePercentileAggregationV2.md index db6955660..95febd549 100644 --- a/docs/v2/models/ApproximatePercentileAggregationV2.md +++ b/docs/v2/models/ApproximatePercentileAggregationV2.md @@ -1,6 +1,6 @@ # ApproximatePercentileAggregationV2 -Computes the approximate percentile value for the provided field. +Computes the approximate percentile value for the provided field. Requires Object Storage V2. ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/models/ApproximatePercentileAggregationV2Dict.md b/docs/v2/models/ApproximatePercentileAggregationV2Dict.md index 7cf991c8f..f8d2a8c11 100644 --- a/docs/v2/models/ApproximatePercentileAggregationV2Dict.md +++ b/docs/v2/models/ApproximatePercentileAggregationV2Dict.md @@ -1,6 +1,6 @@ # ApproximatePercentileAggregationV2Dict -Computes the approximate percentile value for the provided field. +Computes the approximate percentile value for the provided field. Requires Object Storage V2. ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/models/ArchiveFileFormat.md b/docs/v2/models/ArchiveFileFormat.md index fd91dddaf..c6d9af08a 100644 --- a/docs/v2/models/ArchiveFileFormat.md +++ b/docs/v2/models/ArchiveFileFormat.md @@ -5,7 +5,7 @@ The format of an archive file. | **Value** | | --------- | -| `"('values', ['ZIP'])"` | +| `"ZIP"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncActionStatus.md b/docs/v2/models/AsyncActionStatus.md index 61814e4fc..2904ec8b4 100644 --- a/docs/v2/models/AsyncActionStatus.md +++ b/docs/v2/models/AsyncActionStatus.md @@ -4,7 +4,13 @@ AsyncActionStatus | **Value** | | --------- | -| `"('values', ['RUNNING_SUBMISSION_CHECKS', 'EXECUTING_WRITE_BACK_WEBHOOK', 'COMPUTING_ONTOLOGY_EDITS', 'COMPUTING_FUNCTION', 'WRITING_ONTOLOGY_EDITS', 'EXECUTING_SIDE_EFFECT_WEBHOOK', 'SENDING_NOTIFICATIONS'])"` | +| `"RUNNING_SUBMISSION_CHECKS"` | +| `"EXECUTING_WRITE_BACK_WEBHOOK"` | +| `"COMPUTING_ONTOLOGY_EDITS"` | +| `"COMPUTING_FUNCTION"` | +| `"WRITING_ONTOLOGY_EDITS"` | +| `"EXECUTING_SIDE_EFFECT_WEBHOOK"` | +| `"SENDING_NOTIFICATIONS"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Build.md b/docs/v2/models/Build.md index bb3102fc8..83e98c2e2 100644 --- a/docs/v2/models/Build.md +++ b/docs/v2/models/Build.md @@ -6,8 +6,10 @@ Build | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **rid** | BuildRid | Yes | The RID of a build | +**branch_name** | BranchName | Yes | The branch that the build is running on. | **created_time** | CreatedTime | Yes | The timestamp that the build was created. | **created_by** | CreatedBy | Yes | The user who created the build. | +**fallback_branches** | FallbackBranches | Yes | | **retry_count** | RetryCount | Yes | | **retry_backoff_duration** | RetryBackoffDuration | Yes | | **abort_on_failure** | AbortOnFailure | Yes | | diff --git a/docs/v2/models/BuildDict.md b/docs/v2/models/BuildDict.md index ec5a08d8e..d71f48227 100644 --- a/docs/v2/models/BuildDict.md +++ b/docs/v2/models/BuildDict.md @@ -6,8 +6,10 @@ Build | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **rid** | BuildRid | Yes | The RID of a build | +**branchName** | BranchName | Yes | The branch that the build is running on. | **createdTime** | CreatedTime | Yes | The timestamp that the build was created. | **createdBy** | CreatedBy | Yes | The user who created the build. | +**fallbackBranches** | FallbackBranches | Yes | | **retryCount** | RetryCount | Yes | | **retryBackoffDuration** | RetryBackoffDurationDict | Yes | | **abortOnFailure** | AbortOnFailure | Yes | | diff --git a/docs/v2/models/BuildStatus.md b/docs/v2/models/BuildStatus.md index 7c4ab71a8..8c2998268 100644 --- a/docs/v2/models/BuildStatus.md +++ b/docs/v2/models/BuildStatus.md @@ -4,7 +4,10 @@ The status of the build. | **Value** | | --------- | -| `"('values', ['RUNNING', 'SUCCEEDED', 'FAILED', 'CANCELED'])"` | +| `"RUNNING"` | +| `"SUCCEEDED"` | +| `"FAILED"` | +| `"CANCELED"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatCompletionRequest.md b/docs/v2/models/ChatCompletionRequest.md deleted file mode 100644 index c92a2c571..000000000 --- a/docs/v2/models/ChatCompletionRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatCompletionRequest - -ChatCompletionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**messages** | List[ChatMessage] | Yes | | -**parameters** | Dict[ParameterKey, ParameterValue] | Yes | Any additional model-specific parameters: - for global models, the keys can be one of the following (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - `temperature` - `top_p` - `n` - `stop` - `max_tokens` - `presence_penalty` - `frequency_penalty` - `logit_bias` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatCompletionRequestDict.md b/docs/v2/models/ChatCompletionRequestDict.md deleted file mode 100644 index ab048c7d3..000000000 --- a/docs/v2/models/ChatCompletionRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ChatCompletionRequestDict - -ChatCompletionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**messages** | List[ChatMessageDict] | Yes | | -**parameters** | Dict[ParameterKey, ParameterValue] | Yes | Any additional model-specific parameters: - for global models, the keys can be one of the following (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - `temperature` - `top_p` - `n` - `stop` - `max_tokens` - `presence_penalty` - `frequency_penalty` - `logit_bias` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateBuildsRequest.md b/docs/v2/models/CreateBuildsRequest.md new file mode 100644 index 000000000..a4645e035 --- /dev/null +++ b/docs/v2/models/CreateBuildsRequest.md @@ -0,0 +1,18 @@ +# CreateBuildsRequest + +CreateBuildsRequest + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**target** | BuildTarget | Yes | The targets of the schedule. | +**branch_name** | Optional[BranchName] | No | The target branch the build should run on. | +**fallback_branches** | FallbackBranches | Yes | | +**force_build** | Optional[ForceBuild] | No | | +**retry_count** | Optional[RetryCount] | No | The number of retry attempts for failed jobs. | +**retry_backoff_duration** | Optional[RetryBackoffDuration] | No | | +**abort_on_failure** | Optional[AbortOnFailure] | No | | +**notifications_enabled** | Optional[NotificationsEnabled] | No | | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateBuildsRequestDict.md b/docs/v2/models/CreateBuildsRequestDict.md new file mode 100644 index 000000000..ad84bb067 --- /dev/null +++ b/docs/v2/models/CreateBuildsRequestDict.md @@ -0,0 +1,18 @@ +# CreateBuildsRequestDict + +CreateBuildsRequest + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**target** | BuildTargetDict | Yes | The targets of the schedule. | +**branchName** | NotRequired[BranchName] | No | The target branch the build should run on. | +**fallbackBranches** | FallbackBranches | Yes | | +**forceBuild** | NotRequired[ForceBuild] | No | | +**retryCount** | NotRequired[RetryCount] | No | The number of retry attempts for failed jobs. | +**retryBackoffDuration** | NotRequired[RetryBackoffDurationDict] | No | | +**abortOnFailure** | NotRequired[AbortOnFailure] | No | | +**notificationsEnabled** | NotRequired[NotificationsEnabled] | No | | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DistanceUnit.md b/docs/v2/models/DistanceUnit.md index 17f4ed9df..e0e15461a 100644 --- a/docs/v2/models/DistanceUnit.md +++ b/docs/v2/models/DistanceUnit.md @@ -4,7 +4,15 @@ DistanceUnit | **Value** | | --------- | -| `"('values', ['MILLIMETERS', 'CENTIMETERS', 'METERS', 'KILOMETERS', 'INCHES', 'FEET', 'YARDS', 'MILES', 'NAUTICAL_MILES'])"` | +| `"MILLIMETERS"` | +| `"CENTIMETERS"` | +| `"METERS"` | +| `"KILOMETERS"` | +| `"INCHES"` | +| `"FEET"` | +| `"YARDS"` | +| `"MILES"` | +| `"NAUTICAL_MILES"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Duration.md b/docs/v2/models/Duration.md index e228bc720..694f79def 100644 --- a/docs/v2/models/Duration.md +++ b/docs/v2/models/Duration.md @@ -5,7 +5,7 @@ A measurement of duration. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**value** | StrictFloat | Yes | The duration value. | +**value** | StrictInt | Yes | The duration value. | **unit** | TimeUnit | Yes | The unit of duration. | diff --git a/docs/v2/models/DurationDict.md b/docs/v2/models/DurationDict.md index 45e643189..47d7d0a43 100644 --- a/docs/v2/models/DurationDict.md +++ b/docs/v2/models/DurationDict.md @@ -5,7 +5,7 @@ A measurement of duration. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**value** | StrictFloat | Yes | The duration value. | +**value** | StrictInt | Yes | The duration value. | **unit** | TimeUnit | Yes | The unit of duration. | diff --git a/docs/v2/models/ExactDistinctAggregationV2.md b/docs/v2/models/ExactDistinctAggregationV2.md new file mode 100644 index 000000000..b4c98b410 --- /dev/null +++ b/docs/v2/models/ExactDistinctAggregationV2.md @@ -0,0 +1,14 @@ +# ExactDistinctAggregationV2 + +Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | Optional[AggregationMetricName] | No | | +**direction** | Optional[OrderByDirection] | No | | +**type** | Literal["exactDistinct"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExactDistinctAggregationV2Dict.md b/docs/v2/models/ExactDistinctAggregationV2Dict.md new file mode 100644 index 000000000..356c3d26c --- /dev/null +++ b/docs/v2/models/ExactDistinctAggregationV2Dict.md @@ -0,0 +1,14 @@ +# ExactDistinctAggregationV2Dict + +Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["exactDistinct"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatCompletionChoice.md b/docs/v2/models/Folder.md similarity index 75% rename from docs/v2/models/ChatCompletionChoice.md rename to docs/v2/models/Folder.md index 27f506eda..5c8f6f183 100644 --- a/docs/v2/models/ChatCompletionChoice.md +++ b/docs/v2/models/Folder.md @@ -1,11 +1,11 @@ -# ChatCompletionChoice +# Folder -ChatCompletionChoice +Folder ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**message** | Optional[ChatMessage] | No | | +**rid** | FolderRid | Yes | | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatCompletionChoiceDict.md b/docs/v2/models/FolderDict.md similarity index 73% rename from docs/v2/models/ChatCompletionChoiceDict.md rename to docs/v2/models/FolderDict.md index 192534823..9f41e6ed1 100644 --- a/docs/v2/models/ChatCompletionChoiceDict.md +++ b/docs/v2/models/FolderDict.md @@ -1,11 +1,11 @@ -# ChatCompletionChoiceDict +# FolderDict -ChatCompletionChoice +Folder ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**message** | NotRequired[ChatMessageDict] | No | | +**rid** | FolderRid | Yes | | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FolderRid.md b/docs/v2/models/FolderRid.md index b52930c55..a4d94cc45 100644 --- a/docs/v2/models/FolderRid.md +++ b/docs/v2/models/FolderRid.md @@ -1,6 +1,6 @@ # FolderRid -FolderRid +The unique resource identifier (RID) of a Folder. ## Type ```python diff --git a/docs/v2/models/InterfaceLinkTypeCardinality.md b/docs/v2/models/InterfaceLinkTypeCardinality.md index db8dfb3c3..fe8217324 100644 --- a/docs/v2/models/InterfaceLinkTypeCardinality.md +++ b/docs/v2/models/InterfaceLinkTypeCardinality.md @@ -6,7 +6,8 @@ link to zero or one other objects, or "MANY", meaning an object can link to any | **Value** | | --------- | -| `"('values', ['ONE', 'MANY'])"` | +| `"ONE"` | +| `"MANY"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IrVersion.md b/docs/v2/models/IrVersion.md index 9ade02b45..d956abccb 100644 --- a/docs/v2/models/IrVersion.md +++ b/docs/v2/models/IrVersion.md @@ -4,7 +4,7 @@ IrVersion | **Value** | | --------- | -| `"('values', ['v1'])"` | +| `"v1"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LanguageModel.md b/docs/v2/models/LanguageModel.md deleted file mode 100644 index 421883c00..000000000 --- a/docs/v2/models/LanguageModel.md +++ /dev/null @@ -1,12 +0,0 @@ -# LanguageModel - -Represents a language model. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | Optional[LanguageModelApiName] | No | | -**source** | Optional[LanguageModelSource] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LanguageModelApiName.md b/docs/v2/models/LanguageModelApiName.md deleted file mode 100644 index 4a775fd95..000000000 --- a/docs/v2/models/LanguageModelApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# LanguageModelApiName - -The name of the language model in the API. To find the API name for your model, use the `List language models` -endpoint. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LanguageModelDict.md b/docs/v2/models/LanguageModelDict.md deleted file mode 100644 index ffd386ac1..000000000 --- a/docs/v2/models/LanguageModelDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LanguageModelDict - -Represents a language model. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | NotRequired[LanguageModelApiName] | No | | -**source** | NotRequired[LanguageModelSource] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeSideCardinality.md b/docs/v2/models/LinkTypeSideCardinality.md index e9ccc5113..bd4c7554b 100644 --- a/docs/v2/models/LinkTypeSideCardinality.md +++ b/docs/v2/models/LinkTypeSideCardinality.md @@ -4,7 +4,8 @@ LinkTypeSideCardinality | **Value** | | --------- | -| `"('values', ['ONE', 'MANY'])"` | +| `"ONE"` | +| `"MANY"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListLanguageModelsResponse.md b/docs/v2/models/ListLanguageModelsResponse.md deleted file mode 100644 index cf6d7526e..000000000 --- a/docs/v2/models/ListLanguageModelsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListLanguageModelsResponse - -ListLanguageModelsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[LanguageModel] | Yes | The list of language models. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListLanguageModelsResponseDict.md b/docs/v2/models/ListLanguageModelsResponseDict.md deleted file mode 100644 index 8d68af333..000000000 --- a/docs/v2/models/ListLanguageModelsResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListLanguageModelsResponseDict - -ListLanguageModelsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[LanguageModelDict] | Yes | The list of language models. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStreamSubscribeRequest.md b/docs/v2/models/ObjectSetStreamSubscribeRequest.md index c8a69fbe1..8be7d450d 100644 --- a/docs/v2/models/ObjectSetStreamSubscribeRequest.md +++ b/docs/v2/models/ObjectSetStreamSubscribeRequest.md @@ -5,7 +5,6 @@ ObjectSetStreamSubscribeRequest ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**ontology** | Optional[OntologyIdentifier] | No | | **object_set** | ObjectSet | Yes | | **property_set** | List[SelectedPropertyApiName] | Yes | | **reference_set** | List[SelectedPropertyApiName] | Yes | | diff --git a/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md b/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md index a3e450e7c..dc0f45106 100644 --- a/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md +++ b/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md @@ -5,7 +5,6 @@ ObjectSetStreamSubscribeRequest ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**ontology** | NotRequired[OntologyIdentifier] | No | | **objectSet** | ObjectSetDict | Yes | | **propertySet** | List[SelectedPropertyApiName] | Yes | | **referenceSet** | List[SelectedPropertyApiName] | Yes | | diff --git a/docs/v2/models/ObjectState.md b/docs/v2/models/ObjectState.md index 2c09a36fa..4d5b671f9 100644 --- a/docs/v2/models/ObjectState.md +++ b/docs/v2/models/ObjectState.md @@ -8,7 +8,8 @@ definition. | **Value** | | --------- | -| `"('values', ['ADDED_OR_UPDATED', 'REMOVED'])"` | +| `"ADDED_OR_UPDATED"` | +| `"REMOVED"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeVisibility.md b/docs/v2/models/ObjectTypeVisibility.md index 894fd0738..6a8df6e71 100644 --- a/docs/v2/models/ObjectTypeVisibility.md +++ b/docs/v2/models/ObjectTypeVisibility.md @@ -4,7 +4,9 @@ The suggested visibility of the object type. | **Value** | | --------- | -| `"('values', ['NORMAL', 'PROMINENT', 'HIDDEN'])"` | +| `"NORMAL"` | +| `"PROMINENT"` | +| `"HIDDEN"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrderByDirection.md b/docs/v2/models/OrderByDirection.md index 1301ce99f..0f05890d2 100644 --- a/docs/v2/models/OrderByDirection.md +++ b/docs/v2/models/OrderByDirection.md @@ -4,7 +4,8 @@ OrderByDirection | **Value** | | --------- | -| `"('values', ['ASC', 'DESC'])"` | +| `"ASC"` | +| `"DESC"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrincipalFilterType.md b/docs/v2/models/PrincipalFilterType.md index b289d5d56..b8c9f75e0 100644 --- a/docs/v2/models/PrincipalFilterType.md +++ b/docs/v2/models/PrincipalFilterType.md @@ -4,7 +4,7 @@ PrincipalFilterType | **Value** | | --------- | -| `"('values', ['queryString'])"` | +| `"queryString"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrincipalType.md b/docs/v2/models/PrincipalType.md index b7745b83e..f3045ad4a 100644 --- a/docs/v2/models/PrincipalType.md +++ b/docs/v2/models/PrincipalType.md @@ -4,7 +4,8 @@ PrincipalType | **Value** | | --------- | -| `"('values', ['USER', 'GROUP'])"` | +| `"USER"` | +| `"GROUP"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatMessage.md b/docs/v2/models/Project.md similarity index 71% rename from docs/v2/models/ChatMessage.md rename to docs/v2/models/Project.md index 475f1f68a..dfe9acd76 100644 --- a/docs/v2/models/ChatMessage.md +++ b/docs/v2/models/Project.md @@ -1,12 +1,11 @@ -# ChatMessage +# Project -ChatMessage +Project ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**role** | ChatMessageRole | Yes | | -**content** | Optional[StrictStr] | No | | +**rid** | ProjectRid | Yes | | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatMessageDict.md b/docs/v2/models/ProjectDict.md similarity index 70% rename from docs/v2/models/ChatMessageDict.md rename to docs/v2/models/ProjectDict.md index b56b9686c..6f2c97b94 100644 --- a/docs/v2/models/ChatMessageDict.md +++ b/docs/v2/models/ProjectDict.md @@ -1,12 +1,11 @@ -# ChatMessageDict +# ProjectDict -ChatMessage +Project ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**role** | ChatMessageRole | Yes | | -**content** | NotRequired[StrictStr] | No | | +**rid** | ProjectRid | Yes | | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ProjectRid.md b/docs/v2/models/ProjectRid.md index a025aaa0e..313106f28 100644 --- a/docs/v2/models/ProjectRid.md +++ b/docs/v2/models/ProjectRid.md @@ -1,7 +1,6 @@ # ProjectRid -The Resource Identifier (RID) of a Project. - +The unique resource identifier (RID) of a Project. ## Type ```python diff --git a/docs/v2/models/ReasonType.md b/docs/v2/models/ReasonType.md index 8112e3b18..2093a2140 100644 --- a/docs/v2/models/ReasonType.md +++ b/docs/v2/models/ReasonType.md @@ -5,7 +5,8 @@ Represents the reason a subscription was closed. | **Value** | | --------- | -| `"('values', ['USER_CLOSED', 'CHANNEL_CLOSED'])"` | +| `"USER_CLOSED"` | +| `"CHANNEL_CLOSED"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReferenceUpdate.md b/docs/v2/models/ReferenceUpdate.md index b417b9594..7105a66ac 100644 --- a/docs/v2/models/ReferenceUpdate.md +++ b/docs/v2/models/ReferenceUpdate.md @@ -8,9 +8,9 @@ field returns a dereferenced value rather than the reference itself. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | +**object_type** | ObjectTypeApiName | Yes | | **primary_key** | ObjectPrimaryKey | Yes | | -**property_api_name** | PropertyApiName | Yes | | +**property** | PropertyApiName | Yes | | **value** | ReferenceValue | Yes | | **type** | Literal["reference"] | Yes | None | diff --git a/docs/v2/models/ReferenceUpdateDict.md b/docs/v2/models/ReferenceUpdateDict.md index 740733191..757a64d08 100644 --- a/docs/v2/models/ReferenceUpdateDict.md +++ b/docs/v2/models/ReferenceUpdateDict.md @@ -8,9 +8,9 @@ field returns a dereferenced value rather than the reference itself. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | +**objectType** | ObjectTypeApiName | Yes | | **primaryKey** | ObjectPrimaryKey | Yes | | -**propertyApiName** | PropertyApiName | Yes | | +**property** | PropertyApiName | Yes | | **value** | ReferenceValueDict | Yes | | **type** | Literal["reference"] | Yes | None | diff --git a/docs/v2/models/RelativeTimeRelation.md b/docs/v2/models/RelativeTimeRelation.md index 8523b090b..354930b32 100644 --- a/docs/v2/models/RelativeTimeRelation.md +++ b/docs/v2/models/RelativeTimeRelation.md @@ -4,7 +4,8 @@ RelativeTimeRelation | **Value** | | --------- | -| `"('values', ['BEFORE', 'AFTER'])"` | +| `"BEFORE"` | +| `"AFTER"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTimeSeriesTimeUnit.md b/docs/v2/models/RelativeTimeSeriesTimeUnit.md index 44d5f5d18..8b68ec378 100644 --- a/docs/v2/models/RelativeTimeSeriesTimeUnit.md +++ b/docs/v2/models/RelativeTimeSeriesTimeUnit.md @@ -4,7 +4,14 @@ RelativeTimeSeriesTimeUnit | **Value** | | --------- | -| `"('values', ['MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS', 'WEEKS', 'MONTHS', 'YEARS'])"` | +| `"MILLISECONDS"` | +| `"SECONDS"` | +| `"MINUTES"` | +| `"HOURS"` | +| `"DAYS"` | +| `"WEEKS"` | +| `"MONTHS"` | +| `"YEARS"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReleaseStatus.md b/docs/v2/models/ReleaseStatus.md index f4801a8da..400247b06 100644 --- a/docs/v2/models/ReleaseStatus.md +++ b/docs/v2/models/ReleaseStatus.md @@ -4,7 +4,9 @@ The release status of the entity. | **Value** | | --------- | -| `"('values', ['ACTIVE', 'EXPERIMENTAL', 'DEPRECATED'])"` | +| `"ACTIVE"` | +| `"EXPERIMENTAL"` | +| `"DEPRECATED"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Resource.md b/docs/v2/models/Resource.md new file mode 100644 index 000000000..16db83ad0 --- /dev/null +++ b/docs/v2/models/Resource.md @@ -0,0 +1,24 @@ +# Resource + +Resource + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ResourceRid | Yes | | +**display_name** | ResourceDisplayName | Yes | The display name of the Resource | +**description** | Optional[StrictStr] | No | The description of the Resource | +**documentation** | Optional[StrictStr] | No | The documentation associated with the Resource | +**path** | ResourcePath | Yes | The full path to the resource, including the resource name itself | +**type** | ResourceType | Yes | The type of the Resource derived from the Resource Identifier (RID). | +**created_by** | CreatedBy | Yes | The user that created the Resource. | +**updated_by** | UpdatedBy | Yes | The user that last updated the Resource. | +**created_time** | CreatedTime | Yes | The timestamp that the Resource was last created. | +**updated_time** | UpdatedTime | Yes | The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. | +**trashed** | TrashedStatus | Yes | The trash status of the resource. If trashed, a resource can either be directly trashed or one of its ancestors can be trashed. | +**parent_folder_rid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For projects, this will be the Space RID. | +**project_rid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID. | +**space_rid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Resource lives in. | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourceDict.md b/docs/v2/models/ResourceDict.md new file mode 100644 index 000000000..158e27fae --- /dev/null +++ b/docs/v2/models/ResourceDict.md @@ -0,0 +1,24 @@ +# ResourceDict + +Resource + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ResourceRid | Yes | | +**displayName** | ResourceDisplayName | Yes | The display name of the Resource | +**description** | NotRequired[StrictStr] | No | The description of the Resource | +**documentation** | NotRequired[StrictStr] | No | The documentation associated with the Resource | +**path** | ResourcePath | Yes | The full path to the resource, including the resource name itself | +**type** | ResourceType | Yes | The type of the Resource derived from the Resource Identifier (RID). | +**createdBy** | CreatedBy | Yes | The user that created the Resource. | +**updatedBy** | UpdatedBy | Yes | The user that last updated the Resource. | +**createdTime** | CreatedTime | Yes | The timestamp that the Resource was last created. | +**updatedTime** | UpdatedTime | Yes | The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. | +**trashed** | TrashedStatus | Yes | The trash status of the resource. If trashed, a resource can either be directly trashed or one of its ancestors can be trashed. | +**parentFolderRid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For projects, this will be the Space RID. | +**projectRid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID. | +**spaceRid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Resource lives in. | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterKey.md b/docs/v2/models/ResourceDisplayName.md similarity index 75% rename from docs/v2/models/ParameterKey.md rename to docs/v2/models/ResourceDisplayName.md index 8303161e0..d9bcdc33c 100644 --- a/docs/v2/models/ParameterKey.md +++ b/docs/v2/models/ResourceDisplayName.md @@ -1,7 +1,6 @@ -# ParameterKey - -The unique identifier of the model parameter. +# ResourceDisplayName +The display name of the Resource ## Type ```python diff --git a/docs/v2/models/ResourcePath.md b/docs/v2/models/ResourcePath.md index 20b33b35c..8f5db17b6 100644 --- a/docs/v2/models/ResourcePath.md +++ b/docs/v2/models/ResourcePath.md @@ -1,7 +1,6 @@ # ResourcePath -A path in the Foundry file tree. - +The full path to the resource, including the resource name itself ## Type ```python diff --git a/docs/v2/models/LanguageModelSource.md b/docs/v2/models/ResourceRid.md similarity index 58% rename from docs/v2/models/LanguageModelSource.md rename to docs/v2/models/ResourceRid.md index 852f2dd4e..d210ef4b8 100644 --- a/docs/v2/models/LanguageModelSource.md +++ b/docs/v2/models/ResourceRid.md @@ -1,10 +1,11 @@ -# LanguageModelSource +# ResourceRid -LanguageModelSource +The unique resource identifier (RID) of a Resource. -| **Value** | -| --------- | -| `"('values', ['global', 'hosted'])"` | +## Type +```python +RID +``` [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourceType.md b/docs/v2/models/ResourceType.md new file mode 100644 index 000000000..d2f0d9c7a --- /dev/null +++ b/docs/v2/models/ResourceType.md @@ -0,0 +1,58 @@ +# ResourceType + +The type of a resource. + +| **Value** | +| --------- | +| `"Academy_Tutorial"` | +| `"Artifacts_Repository"` | +| `"Automate_Automation"` | +| `"Builder_Pipeline"` | +| `"Carbon_Workspace"` | +| `"Cipher_Channel"` | +| `"Code_Repository"` | +| `"Code_Workbook"` | +| `"Code_Workspace"` | +| `"Connectivity_Agent"` | +| `"Connectivity_Source"` | +| `"Connectivity_VirtualTable"` | +| `"Contour_Analysis"` | +| `"Data_Lineage_Graph"` | +| `"Datasets_Dataset"` | +| `"Filesystem_Document"` | +| `"Filesystem_Folder"` | +| `"Filesystem_Image"` | +| `"Filesystem_Project"` | +| `"Filesystem_Space"` | +| `"Filesystem_WebLink"` | +| `"Foundry_Form"` | +| `"Foundry_Report"` | +| `"Foundry_Template"` | +| `"FoundryRules_Workflow"` | +| `"Fusion_Document"` | +| `"Logic_Function"` | +| `"Machinery_ProcessGraph"` | +| `"Maps_Layer"` | +| `"Maps_Map"` | +| `"Marketplace_Installation"` | +| `"Marketplace_LocalStore"` | +| `"Marketplace_RemoteStore"` | +| `"Media_Set"` | +| `"Modeling_Model"` | +| `"Modeling_ModelVersion"` | +| `"Modeling_Objective"` | +| `"Monitoring_MonitoringView"` | +| `"Notepad_Document"` | +| `"Notepad_Template"` | +| `"ObjectExploration_Exploration"` | +| `"ObjectExploration_Layout"` | +| `"Quiver_Analysis"` | +| `"Slate_Application"` | +| `"SolutionDesigner_Diagram"` | +| `"ThirdPartyApplication_ThirdPartyApplication"` | +| `"Unknown"` | +| `"Vertex_Graph"` | +| `"Workshop_Module"` | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReturnEditsMode.md b/docs/v2/models/ReturnEditsMode.md index eebe7f364..3d08ba54c 100644 --- a/docs/v2/models/ReturnEditsMode.md +++ b/docs/v2/models/ReturnEditsMode.md @@ -4,7 +4,8 @@ ReturnEditsMode | **Value** | | --------- | -| `"('values', ['ALL', 'NONE'])"` | +| `"ALL"` | +| `"NONE"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Schedule.md b/docs/v2/models/Schedule.md index bb14701f8..390275c60 100644 --- a/docs/v2/models/Schedule.md +++ b/docs/v2/models/Schedule.md @@ -8,7 +8,7 @@ Schedule **rid** | ScheduleRid | Yes | | **display_name** | Optional[StrictStr] | No | | **description** | Optional[StrictStr] | No | | -**version_rid** | ScheduleVersionRid | Yes | The RID of the current schedule version | +**current_version_rid** | ScheduleVersionRid | Yes | The RID of the current schedule version | **created_time** | CreatedTime | Yes | | **created_by** | CreatedBy | Yes | | **updated_time** | UpdatedTime | Yes | | diff --git a/docs/v2/models/ScheduleDict.md b/docs/v2/models/ScheduleDict.md index 19d6fdf4d..0821431b4 100644 --- a/docs/v2/models/ScheduleDict.md +++ b/docs/v2/models/ScheduleDict.md @@ -8,7 +8,7 @@ Schedule **rid** | ScheduleRid | Yes | | **displayName** | NotRequired[StrictStr] | No | | **description** | NotRequired[StrictStr] | No | | -**versionRid** | ScheduleVersionRid | Yes | The RID of the current schedule version | +**currentVersionRid** | ScheduleVersionRid | Yes | The RID of the current schedule version | **createdTime** | CreatedTime | Yes | | **createdBy** | CreatedBy | Yes | | **updatedTime** | UpdatedTime | Yes | | diff --git a/docs/v2/models/ScheduleRun.md b/docs/v2/models/ScheduleRun.md new file mode 100644 index 000000000..2c355fdd3 --- /dev/null +++ b/docs/v2/models/ScheduleRun.md @@ -0,0 +1,16 @@ +# ScheduleRun + +ScheduleRun + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ScheduleRunRid | Yes | The RID of a schedule run | +**schedule_rid** | ScheduleRid | Yes | | +**schedule_version_rid** | ScheduleVersionRid | Yes | | +**created_time** | CreatedTime | Yes | The time at which the schedule run was created. | +**created_by** | Optional[CreatedBy] | No | The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to empty. | +**result** | Optional[ScheduleRunResult] | No | The result of triggering the schedule. If empty, it means the service is still working on triggering the schedule. | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunDict.md b/docs/v2/models/ScheduleRunDict.md new file mode 100644 index 000000000..0db25724e --- /dev/null +++ b/docs/v2/models/ScheduleRunDict.md @@ -0,0 +1,16 @@ +# ScheduleRunDict + +ScheduleRun + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ScheduleRunRid | Yes | The RID of a schedule run | +**scheduleRid** | ScheduleRid | Yes | | +**scheduleVersionRid** | ScheduleVersionRid | Yes | | +**createdTime** | CreatedTime | Yes | The time at which the schedule run was created. | +**createdBy** | NotRequired[CreatedBy] | No | The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to empty. | +**result** | NotRequired[ScheduleRunResultDict] | No | The result of triggering the schedule. If empty, it means the service is still working on triggering the schedule. | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatCompletionResponseDict.md b/docs/v2/models/ScheduleRunError.md similarity index 57% rename from docs/v2/models/ChatCompletionResponseDict.md rename to docs/v2/models/ScheduleRunError.md index 2aceb0625..b756fb7ea 100644 --- a/docs/v2/models/ChatCompletionResponseDict.md +++ b/docs/v2/models/ScheduleRunError.md @@ -1,11 +1,13 @@ -# ChatCompletionResponseDict +# ScheduleRunError -Contains `n` different completion choices as specified in the request parameter. +An error occurred attempting to run the schedule. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**choices** | List[ChatCompletionChoiceDict] | Yes | | +**error_name** | ScheduleRunErrorName | Yes | | +**description** | StrictStr | Yes | | +**type** | Literal["error"] | Yes | None | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatCompletionResponse.md b/docs/v2/models/ScheduleRunErrorDict.md similarity index 57% rename from docs/v2/models/ChatCompletionResponse.md rename to docs/v2/models/ScheduleRunErrorDict.md index 3dda228fb..a0fa2c1e3 100644 --- a/docs/v2/models/ChatCompletionResponse.md +++ b/docs/v2/models/ScheduleRunErrorDict.md @@ -1,11 +1,13 @@ -# ChatCompletionResponse +# ScheduleRunErrorDict -Contains `n` different completion choices as specified in the request parameter. +An error occurred attempting to run the schedule. ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**choices** | List[ChatCompletionChoice] | Yes | | +**errorName** | ScheduleRunErrorName | Yes | | +**description** | StrictStr | Yes | | +**type** | Literal["error"] | Yes | None | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunErrorName.md b/docs/v2/models/ScheduleRunErrorName.md new file mode 100644 index 000000000..be4657823 --- /dev/null +++ b/docs/v2/models/ScheduleRunErrorName.md @@ -0,0 +1,16 @@ +# ScheduleRunErrorName + +ScheduleRunErrorName + +| **Value** | +| --------- | +| `"TargetResolutionFailure"` | +| `"CyclicDependency"` | +| `"IncompatibleTargets"` | +| `"PermissionDenied"` | +| `"JobSpecNotFound"` | +| `"ScheduleOwnerNotFound"` | +| `"Internal"` | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunIgnored.md b/docs/v2/models/ScheduleRunIgnored.md new file mode 100644 index 000000000..423304505 --- /dev/null +++ b/docs/v2/models/ScheduleRunIgnored.md @@ -0,0 +1,12 @@ +# ScheduleRunIgnored + +The schedule is not running as all targets are up-to-date. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["ignored"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunIgnoredDict.md b/docs/v2/models/ScheduleRunIgnoredDict.md new file mode 100644 index 000000000..dee3ecee8 --- /dev/null +++ b/docs/v2/models/ScheduleRunIgnoredDict.md @@ -0,0 +1,12 @@ +# ScheduleRunIgnoredDict + +The schedule is not running as all targets are up-to-date. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["ignored"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunResult.md b/docs/v2/models/ScheduleRunResult.md new file mode 100644 index 000000000..91a09e502 --- /dev/null +++ b/docs/v2/models/ScheduleRunResult.md @@ -0,0 +1,19 @@ +# ScheduleRunResult + +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +[ScheduleRunSubmitted](ScheduleRunSubmitted.md) | submitted +[ScheduleRunIgnored](ScheduleRunIgnored.md) | ignored +[ScheduleRunError](ScheduleRunError.md) | error + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunResultDict.md b/docs/v2/models/ScheduleRunResultDict.md new file mode 100644 index 000000000..0f4f51af8 --- /dev/null +++ b/docs/v2/models/ScheduleRunResultDict.md @@ -0,0 +1,19 @@ +# ScheduleRunResultDict + +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +[ScheduleRunSubmittedDict](ScheduleRunSubmittedDict.md) | submitted +[ScheduleRunIgnoredDict](ScheduleRunIgnoredDict.md) | ignored +[ScheduleRunErrorDict](ScheduleRunErrorDict.md) | error + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterValue.md b/docs/v2/models/ScheduleRunRid.md similarity index 79% rename from docs/v2/models/ParameterValue.md rename to docs/v2/models/ScheduleRunRid.md index c6a455c31..ab78a1f7a 100644 --- a/docs/v2/models/ParameterValue.md +++ b/docs/v2/models/ScheduleRunRid.md @@ -1,10 +1,10 @@ -# ParameterValue +# ScheduleRunRid -ParameterValue +The RID of a schedule run ## Type ```python -Any +RID ``` diff --git a/docs/v2/models/ScheduleRunSubmitted.md b/docs/v2/models/ScheduleRunSubmitted.md new file mode 100644 index 000000000..295df56d9 --- /dev/null +++ b/docs/v2/models/ScheduleRunSubmitted.md @@ -0,0 +1,12 @@ +# ScheduleRunSubmitted + +The schedule has been successfully triggered. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**build_rid** | BuildRid | Yes | | +**type** | Literal["submitted"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunSubmittedDict.md b/docs/v2/models/ScheduleRunSubmittedDict.md new file mode 100644 index 000000000..6bf7c8434 --- /dev/null +++ b/docs/v2/models/ScheduleRunSubmittedDict.md @@ -0,0 +1,12 @@ +# ScheduleRunSubmittedDict + +The schedule has been successfully triggered. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**buildRid** | BuildRid | Yes | | +**type** | Literal["submitted"] | Yes | None | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Space.md b/docs/v2/models/Space.md new file mode 100644 index 000000000..77e536b9e --- /dev/null +++ b/docs/v2/models/Space.md @@ -0,0 +1,11 @@ +# Space + +Space + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | SpaceRid | Yes | | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SpaceDict.md b/docs/v2/models/SpaceDict.md new file mode 100644 index 000000000..63e530ac7 --- /dev/null +++ b/docs/v2/models/SpaceDict.md @@ -0,0 +1,11 @@ +# SpaceDict + +Space + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | SpaceRid | Yes | | + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SpaceRid.md b/docs/v2/models/SpaceRid.md new file mode 100644 index 000000000..8ec5c9fe9 --- /dev/null +++ b/docs/v2/models/SpaceRid.md @@ -0,0 +1,11 @@ +# SpaceRid + +The unique resource identifier (RID) of a Space. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TableExportFormat.md b/docs/v2/models/TableExportFormat.md index ff96c5f89..7f4ac6b2e 100644 --- a/docs/v2/models/TableExportFormat.md +++ b/docs/v2/models/TableExportFormat.md @@ -5,7 +5,8 @@ Format for tabular dataset export. | **Value** | | --------- | -| `"('values', ['ARROW', 'CSV'])"` | +| `"ARROW"` | +| `"CSV"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeUnit.md b/docs/v2/models/TimeUnit.md index 0a068e710..337a0ab4f 100644 --- a/docs/v2/models/TimeUnit.md +++ b/docs/v2/models/TimeUnit.md @@ -4,7 +4,14 @@ TimeUnit | **Value** | | --------- | -| `"('values', ['MILLISECONDS', 'SECONDS', 'MINUTES', 'HOURS', 'DAYS', 'WEEKS', 'MONTHS', 'YEARS', 'QUARTERS'])"` | +| `"MILLISECONDS"` | +| `"SECONDS"` | +| `"MINUTES"` | +| `"HOURS"` | +| `"DAYS"` | +| `"WEEKS"` | +| `"MONTHS"` | +| `"YEARS"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionStatus.md b/docs/v2/models/TransactionStatus.md index 2767d9896..8eacda4b6 100644 --- a/docs/v2/models/TransactionStatus.md +++ b/docs/v2/models/TransactionStatus.md @@ -5,7 +5,9 @@ The status of a Transaction. | **Value** | | --------- | -| `"('values', ['ABORTED', 'COMMITTED', 'OPEN'])"` | +| `"ABORTED"` | +| `"COMMITTED"` | +| `"OPEN"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionType.md b/docs/v2/models/TransactionType.md index e950c674e..203bb4692 100644 --- a/docs/v2/models/TransactionType.md +++ b/docs/v2/models/TransactionType.md @@ -5,7 +5,10 @@ The type of a Transaction. | **Value** | | --------- | -| `"('values', ['APPEND', 'UPDATE', 'SNAPSHOT', 'DELETE'])"` | +| `"APPEND"` | +| `"UPDATE"` | +| `"SNAPSHOT"` | +| `"DELETE"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ChatMessageRole.md b/docs/v2/models/TrashedStatus.md similarity index 64% rename from docs/v2/models/ChatMessageRole.md rename to docs/v2/models/TrashedStatus.md index 61aec13fc..95fea99c4 100644 --- a/docs/v2/models/ChatMessageRole.md +++ b/docs/v2/models/TrashedStatus.md @@ -1,10 +1,12 @@ -# ChatMessageRole +# TrashedStatus -ChatMessageRole +TrashedStatus | **Value** | | --------- | -| `"('values', ['SYSTEM', 'ASSISTANT', 'USER'])"` | +| `"DIRECTLY_TRASHED"` | +| `"ANCESTOR_TRASHED"` | +| `"NOT_TRASHED"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidationResult.md b/docs/v2/models/ValidationResult.md index 199adb18a..0bf3692f1 100644 --- a/docs/v2/models/ValidationResult.md +++ b/docs/v2/models/ValidationResult.md @@ -5,7 +5,8 @@ Represents the state of a validation. | **Value** | | --------- | -| `"('values', ['VALID', 'INVALID'])"` | +| `"VALID"` | +| `"INVALID"` | [[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/namespaces/Orchestration/Build.md b/docs/v2/namespaces/Orchestration/Build.md index 45e7cd090..137c3ad22 100644 --- a/docs/v2/namespaces/Orchestration/Build.md +++ b/docs/v2/namespaces/Orchestration/Build.md @@ -2,8 +2,69 @@ Method | HTTP request | ------------- | ------------- | +[**create**](#create) | **POST** /v2/orchestration/builds/create | [**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | +# **create** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**create_builds_request** | Union[CreateBuildsRequest, CreateBuildsRequestDict] | Body of the request | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Build** + +### Example + +```python +from foundry.v2 import FoundryV2Client +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryV2Client( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Union[CreateBuildsRequest, CreateBuildsRequestDict] | Body of the request +create_builds_request = { + "retryBackoffDuration": {"unit": "SECONDS", "value": 30}, + "fallbackBranches": ["master"], + "branchName": "master", +} + +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Build.create( + create_builds_request, + preview=preview, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Build.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Build | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) + # **get** Get the Build with the specified rid. diff --git a/docs/v2/namespaces/Orchestration/Schedule.md b/docs/v2/namespaces/Orchestration/Schedule.md index f766db4e6..cc2793654 100644 --- a/docs/v2/namespaces/Orchestration/Schedule.md +++ b/docs/v2/namespaces/Orchestration/Schedule.md @@ -3,6 +3,9 @@ Method | HTTP request | ------------- | ------------- | [**get**](#get) | **GET** /v2/orchestration/schedules/{scheduleRid} | +[**pause**](#pause) | **POST** /v2/orchestration/schedules/{scheduleRid}/pause | +[**run**](#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | +[**unpause**](#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | # **get** Get the Schedule with the specified rid. @@ -60,3 +63,171 @@ See [README](../../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) +# **pause** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryV2Client +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryV2Client( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None + +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.pause( + schedule_rid, + preview=preview, + ) + print("The pause response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.pause: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) + +# **run** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ScheduleRun** + +### Example + +```python +from foundry.v2 import FoundryV2Client +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryV2Client( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None + +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.run( + schedule_rid, + preview=preview, + ) + print("The run response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.run: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ScheduleRun | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) + +# **unpause** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryV2Client +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryV2Client( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None + +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.unpause( + schedule_rid, + preview=preview, + ) + print("The unpause response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.unpause: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) + diff --git a/foundry/_core/auth_utils.py b/foundry/_core/auth_utils.py index 4e1485cf1..8ce02d4a3 100644 --- a/foundry/_core/auth_utils.py +++ b/foundry/_core/auth_utils.py @@ -22,6 +22,7 @@ class Token(ABC): + @property @abstractmethod def access_token(self) -> str: @@ -29,6 +30,7 @@ def access_token(self) -> str: class Auth(ABC): + @abstractmethod def get_token(self) -> "Token": pass diff --git a/foundry/_core/foundry_token_auth_client.py b/foundry/_core/foundry_token_auth_client.py index 2fadcbf8f..dbdb482e8 100644 --- a/foundry/_core/foundry_token_auth_client.py +++ b/foundry/_core/foundry_token_auth_client.py @@ -27,6 +27,7 @@ class _UserToken(Token): + def __init__(self, token: str) -> None: self._token = token diff --git a/foundry/_core/page_iterator.py b/foundry/_core/page_iterator.py index 40f3cf813..91692bd21 100644 --- a/foundry/_core/page_iterator.py +++ b/foundry/_core/page_iterator.py @@ -26,8 +26,7 @@ class PageFunction(Generic[T], Protocol): def __call__( self, page_size: Optional[int], next_page_token: Optional[str] - ) -> Tuple[Optional[str], List[T]]: - ... + ) -> Tuple[Optional[str], List[T]]: ... class PageIterator(Generic[T]): diff --git a/foundry/_versions.py b/foundry/_versions.py index 55f3ef09d..741154562 100644 --- a/foundry/_versions.py +++ b/foundry/_versions.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.904.0" +__openapi_document_version__ = "1.921.0" diff --git a/foundry/v1/_namespaces/ontologies/query.py b/foundry/v1/_namespaces/ontologies/query.py index 0e9661ede..9ab201f3a 100644 --- a/foundry/v1/_namespaces/ontologies/query.py +++ b/foundry/v1/_namespaces/ontologies/query.py @@ -32,7 +32,6 @@ from foundry.v1.models._execute_query_request_dict import ExecuteQueryRequestDict from foundry.v1.models._execute_query_response import ExecuteQueryResponse from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._preview_mode import PreviewMode from foundry.v1.models._query_api_name import QueryApiName @@ -48,7 +47,6 @@ def execute( query_api_name: QueryApiName, execute_query_request: Union[ExecuteQueryRequest, ExecuteQueryRequestDict], *, - preview: Optional[PreviewMode] = None, request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, ) -> ExecuteQueryResponse: """ @@ -62,8 +60,6 @@ def execute( :type query_api_name: QueryApiName :param execute_query_request: Body of the request :type execute_query_request: Union[ExecuteQueryRequest, ExecuteQueryRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -74,7 +70,6 @@ def execute( _query_params: Dict[str, Any] = {} _header_params: Dict[str, Any] = {} _body_params: Any = execute_query_request - _query_params["preview"] = preview _path_params["ontologyRid"] = ontology_rid diff --git a/foundry/v1/_namespaces/ontologies/query_type.py b/foundry/v1/_namespaces/ontologies/query_type.py index 7f07065b8..beeef48ea 100644 --- a/foundry/v1/_namespaces/ontologies/query_type.py +++ b/foundry/v1/_namespaces/ontologies/query_type.py @@ -32,7 +32,6 @@ from foundry.v1.models._ontology_rid import OntologyRid from foundry.v1.models._page_size import PageSize from foundry.v1.models._page_token import PageToken -from foundry.v1.models._preview_mode import PreviewMode from foundry.v1.models._query_api_name import QueryApiName from foundry.v1.models._query_type import QueryType @@ -48,7 +47,6 @@ def get( ontology_rid: OntologyRid, query_api_name: QueryApiName, *, - preview: Optional[PreviewMode] = None, request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, ) -> QueryType: """ @@ -60,8 +58,6 @@ def get( :type ontology_rid: OntologyRid :param query_api_name: queryApiName :type query_api_name: QueryApiName - :param preview: preview - :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -72,7 +68,6 @@ def get( _query_params: Dict[str, Any] = {} _header_params: Dict[str, Any] = {} _body_params: Any = None - _query_params["preview"] = preview _path_params["ontologyRid"] = ontology_rid @@ -101,7 +96,6 @@ def list( ontology_rid: OntologyRid, *, page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, ) -> ResourceIterator[QueryType]: """ @@ -116,8 +110,6 @@ def list( :type ontology_rid: OntologyRid :param page_size: pageSize :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -130,8 +122,6 @@ def list( _body_params: Any = None _query_params["pageSize"] = page_size - _query_params["preview"] = preview - _path_params["ontologyRid"] = ontology_rid _header_params["Accept"] = "application/json" @@ -158,7 +148,6 @@ def page( *, page_size: Optional[PageSize] = None, page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, ) -> ListQueryTypesResponse: """ @@ -175,8 +164,6 @@ def page( :type page_size: Optional[PageSize] :param page_token: pageToken :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] :param request_timeout: timeout setting for this request in seconds. :type request_timeout: Optional[int] :return: Returns the result object. @@ -191,8 +178,6 @@ def page( _query_params["pageToken"] = page_token - _query_params["preview"] = preview - _path_params["ontologyRid"] = ontology_rid _header_params["Accept"] = "application/json" diff --git a/foundry/v1/cli.py b/foundry/v1/cli.py index 1234d12ca..2ed867eb9 100644 --- a/foundry/v1/cli.py +++ b/foundry/v1/cli.py @@ -790,14 +790,12 @@ def ontologies_query(): @click.argument("ontology_rid", type=str, required=True) @click.argument("query_api_name", type=str, required=True) @click.option("--parameters", type=str, required=True, help="""""") -@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def ontologies_query_execute( client: foundry.v1.FoundryV1Client, ontology_rid: str, query_api_name: str, parameters: str, - preview: Optional[bool], ): """ Executes a Query using the given parameters. Optional parameters do not need to be supplied. @@ -813,7 +811,6 @@ def ontologies_query_execute( "parameters": parameters, } ), - preview=preview, ) click.echo(repr(result)) @@ -1235,13 +1232,11 @@ def ontologies_ontology_query_type(): @ontologies_ontology_query_type.command("get") @click.argument("ontology_rid", type=str, required=True) @click.argument("query_api_name", type=str, required=True) -@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def ontologies_ontology_query_type_get( client: foundry.v1.FoundryV1Client, ontology_rid: str, query_api_name: str, - preview: Optional[bool], ): """ Gets a specific query type with the given API name. @@ -1252,7 +1247,6 @@ def ontologies_ontology_query_type_get( result = client.ontologies.Ontology.QueryType.get( ontology_rid=ontology_rid, query_api_name=query_api_name, - preview=preview, ) click.echo(repr(result)) @@ -1260,13 +1254,11 @@ def ontologies_ontology_query_type_get( @ontologies_ontology_query_type.command("list") @click.argument("ontology_rid", type=str, required=True) @click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def ontologies_ontology_query_type_list( client: foundry.v1.FoundryV1Client, ontology_rid: str, page_size: Optional[int], - preview: Optional[bool], ): """ Lists the query types for the given Ontology. @@ -1280,7 +1272,6 @@ def ontologies_ontology_query_type_list( result = client.ontologies.Ontology.QueryType.list( ontology_rid=ontology_rid, page_size=page_size, - preview=preview, ) click.echo(repr(result)) @@ -1289,14 +1280,12 @@ def ontologies_ontology_query_type_list( @click.argument("ontology_rid", type=str, required=True) @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.option("--page_token", type=str, required=False, help="""pageToken""") -@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def ontologies_ontology_query_type_page( client: foundry.v1.FoundryV1Client, ontology_rid: str, page_size: Optional[int], page_token: Optional[str], - preview: Optional[bool], ): """ Lists the query types for the given Ontology. @@ -1311,7 +1300,6 @@ def ontologies_ontology_query_type_page( ontology_rid=ontology_rid, page_size=page_size, page_token=page_token, - preview=preview, ) click.echo(repr(result)) diff --git a/foundry/v1/models/__init__.py b/foundry/v1/models/__init__.py index d2ff72133..516868e4f 100644 --- a/foundry/v1/models/__init__.py +++ b/foundry/v1/models/__init__.py @@ -247,15 +247,6 @@ from foundry.v1.models._center_point_dict import CenterPointDict from foundry.v1.models._center_point_types import CenterPointTypes from foundry.v1.models._center_point_types_dict import CenterPointTypesDict -from foundry.v1.models._chat_completion_choice import ChatCompletionChoice -from foundry.v1.models._chat_completion_choice_dict import ChatCompletionChoiceDict -from foundry.v1.models._chat_completion_request import ChatCompletionRequest -from foundry.v1.models._chat_completion_request_dict import ChatCompletionRequestDict -from foundry.v1.models._chat_completion_response import ChatCompletionResponse -from foundry.v1.models._chat_completion_response_dict import ChatCompletionResponseDict -from foundry.v1.models._chat_message import ChatMessage -from foundry.v1.models._chat_message_dict import ChatMessageDict -from foundry.v1.models._chat_message_role import ChatMessageRole from foundry.v1.models._contains_all_terms_in_order_prefix_last_term import ( ContainsAllTermsInOrderPrefixLastTerm, ) # NOQA @@ -346,6 +337,10 @@ from foundry.v1.models._error import Error from foundry.v1.models._error_dict import ErrorDict from foundry.v1.models._error_name import ErrorName +from foundry.v1.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 +from foundry.v1.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, +) # NOQA from foundry.v1.models._execute_query_request import ExecuteQueryRequest from foundry.v1.models._execute_query_request_dict import ExecuteQueryRequestDict from foundry.v1.models._execute_query_response import ExecuteQueryResponse @@ -425,10 +420,6 @@ from foundry.v1.models._is_null_query_dict import IsNullQueryDict from foundry.v1.models._is_null_query_v2 import IsNullQueryV2 from foundry.v1.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v1.models._language_model import LanguageModel -from foundry.v1.models._language_model_api_name import LanguageModelApiName -from foundry.v1.models._language_model_dict import LanguageModelDict -from foundry.v1.models._language_model_source import LanguageModelSource from foundry.v1.models._line_string import LineString from foundry.v1.models._line_string_coordinates import LineStringCoordinates from foundry.v1.models._line_string_dict import LineStringDict @@ -466,10 +457,6 @@ from foundry.v1.models._list_interface_types_response_dict import ( ListInterfaceTypesResponseDict, ) # NOQA -from foundry.v1.models._list_language_models_response import ListLanguageModelsResponse -from foundry.v1.models._list_language_models_response_dict import ( - ListLanguageModelsResponseDict, -) # NOQA from foundry.v1.models._list_linked_objects_response import ListLinkedObjectsResponse from foundry.v1.models._list_linked_objects_response_dict import ( ListLinkedObjectsResponseDict, @@ -681,10 +668,8 @@ ParameterEvaluationResultDict, ) # NOQA from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._parameter_key import ParameterKey from foundry.v1.models._parameter_option import ParameterOption from foundry.v1.models._parameter_option_dict import ParameterOptionDict -from foundry.v1.models._parameter_value import ParameterValue from foundry.v1.models._phrase_query import PhraseQuery from foundry.v1.models._phrase_query_dict import PhraseQueryDict from foundry.v1.models._polygon import Polygon @@ -1089,15 +1074,6 @@ "CenterPointDict", "CenterPointTypes", "CenterPointTypesDict", - "ChatCompletionChoice", - "ChatCompletionChoiceDict", - "ChatCompletionRequest", - "ChatCompletionRequestDict", - "ChatCompletionResponse", - "ChatCompletionResponseDict", - "ChatMessage", - "ChatMessageDict", - "ChatMessageRole", "ContainsAllTermsInOrderPrefixLastTerm", "ContainsAllTermsInOrderPrefixLastTermDict", "ContainsAllTermsInOrderQuery", @@ -1166,6 +1142,8 @@ "Error", "ErrorDict", "ErrorName", + "ExactDistinctAggregationV2", + "ExactDistinctAggregationV2Dict", "ExecuteQueryRequest", "ExecuteQueryRequestDict", "ExecuteQueryResponse", @@ -1239,10 +1217,6 @@ "IsNullQueryDict", "IsNullQueryV2", "IsNullQueryV2Dict", - "LanguageModel", - "LanguageModelApiName", - "LanguageModelDict", - "LanguageModelSource", "LinearRing", "LineString", "LineStringCoordinates", @@ -1272,8 +1246,6 @@ "ListFilesResponseDict", "ListInterfaceTypesResponse", "ListInterfaceTypesResponseDict", - "ListLanguageModelsResponse", - "ListLanguageModelsResponseDict", "ListLinkedObjectsResponse", "ListLinkedObjectsResponseDict", "ListLinkedObjectsResponseV2", @@ -1451,10 +1423,8 @@ "ParameterEvaluationResult", "ParameterEvaluationResultDict", "ParameterId", - "ParameterKey", "ParameterOption", "ParameterOptionDict", - "ParameterValue", "PhraseQuery", "PhraseQueryDict", "Polygon", diff --git a/foundry/v1/models/_aggregation_v2.py b/foundry/v1/models/_aggregation_v2.py index ef830da9d..4217f861e 100644 --- a/foundry/v1/models/_aggregation_v2.py +++ b/foundry/v1/models/_aggregation_v2.py @@ -28,6 +28,7 @@ ) # NOQA from foundry.v1.models._avg_aggregation_v2 import AvgAggregationV2 from foundry.v1.models._count_aggregation_v2 import CountAggregationV2 +from foundry.v1.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 from foundry.v1.models._max_aggregation_v2 import MaxAggregationV2 from foundry.v1.models._min_aggregation_v2 import MinAggregationV2 from foundry.v1.models._sum_aggregation_v2 import SumAggregationV2 @@ -41,6 +42,7 @@ CountAggregationV2, ApproximateDistinctAggregationV2, ApproximatePercentileAggregationV2, + ExactDistinctAggregationV2, ], Field(discriminator="type"), ] diff --git a/foundry/v1/models/_aggregation_v2_dict.py b/foundry/v1/models/_aggregation_v2_dict.py index 9b205b357..b9babd56d 100644 --- a/foundry/v1/models/_aggregation_v2_dict.py +++ b/foundry/v1/models/_aggregation_v2_dict.py @@ -28,6 +28,9 @@ ) # NOQA from foundry.v1.models._avg_aggregation_v2_dict import AvgAggregationV2Dict from foundry.v1.models._count_aggregation_v2_dict import CountAggregationV2Dict +from foundry.v1.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, +) # NOQA from foundry.v1.models._max_aggregation_v2_dict import MaxAggregationV2Dict from foundry.v1.models._min_aggregation_v2_dict import MinAggregationV2Dict from foundry.v1.models._sum_aggregation_v2_dict import SumAggregationV2Dict @@ -41,6 +44,7 @@ CountAggregationV2Dict, ApproximateDistinctAggregationV2Dict, ApproximatePercentileAggregationV2Dict, + ExactDistinctAggregationV2Dict, ], Field(discriminator="type"), ] diff --git a/foundry/v1/models/_approximate_percentile_aggregation_v2.py b/foundry/v1/models/_approximate_percentile_aggregation_v2.py index 8d203cc24..e331adcf8 100644 --- a/foundry/v1/models/_approximate_percentile_aggregation_v2.py +++ b/foundry/v1/models/_approximate_percentile_aggregation_v2.py @@ -32,7 +32,7 @@ class ApproximatePercentileAggregationV2(BaseModel): - """Computes the approximate percentile value for the provided field.""" + """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" field: PropertyApiName diff --git a/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py b/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py index db9a863b6..8c40aeaeb 100644 --- a/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py +++ b/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py @@ -27,7 +27,7 @@ class ApproximatePercentileAggregationV2Dict(TypedDict): - """Computes the approximate percentile value for the provided field.""" + """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v1/models/_chat_completion_request.py b/foundry/v1/models/_chat_completion_request.py deleted file mode 100644 index 0a6f0fe21..000000000 --- a/foundry/v1/models/_chat_completion_request.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._chat_completion_request_dict import ChatCompletionRequestDict -from foundry.v1.models._chat_message import ChatMessage -from foundry.v1.models._parameter_key import ParameterKey -from foundry.v1.models._parameter_value import ParameterValue - - -class ChatCompletionRequest(BaseModel): - """ChatCompletionRequest""" - - messages: List[ChatMessage] - - parameters: Dict[ParameterKey, ParameterValue] - """ - Any additional model-specific parameters: - - for global models, the keys can be one of the following - (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - - `temperature` - - `top_p` - - `n` - - `stop` - - `max_tokens` - - `presence_penalty` - - `frequency_penalty` - - `logit_bias` - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> ChatCompletionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatCompletionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_chat_completion_request_dict.py b/foundry/v1/models/_chat_completion_request_dict.py deleted file mode 100644 index 003974066..000000000 --- a/foundry/v1/models/_chat_completion_request_dict.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._chat_message_dict import ChatMessageDict -from foundry.v1.models._parameter_key import ParameterKey -from foundry.v1.models._parameter_value import ParameterValue - - -class ChatCompletionRequestDict(TypedDict): - """ChatCompletionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - messages: List[ChatMessageDict] - - parameters: Dict[ParameterKey, ParameterValue] - """ - Any additional model-specific parameters: - - for global models, the keys can be one of the following - (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - - `temperature` - - `top_p` - - `n` - - `stop` - - `max_tokens` - - `presence_penalty` - - `frequency_penalty` - - `logit_bias` - """ diff --git a/foundry/v1/models/_chat_completion_response.py b/foundry/v1/models/_chat_completion_response.py deleted file mode 100644 index bd8b4537e..000000000 --- a/foundry/v1/models/_chat_completion_response.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._chat_completion_choice import ChatCompletionChoice -from foundry.v1.models._chat_completion_response_dict import ChatCompletionResponseDict - - -class ChatCompletionResponse(BaseModel): - """Contains `n` different completion choices as specified in the request parameter.""" - - choices: List[ChatCompletionChoice] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ChatCompletionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatCompletionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_language_models_response.py b/foundry/v1/models/_exact_distinct_aggregation_v2.py similarity index 51% rename from foundry/v1/models/_list_language_models_response.py rename to foundry/v1/models/_exact_distinct_aggregation_v2.py index 57a8560f4..85ec5a79b 100644 --- a/foundry/v1/models/_list_language_models_response.py +++ b/foundry/v1/models/_exact_distinct_aggregation_v2.py @@ -15,27 +15,35 @@ from __future__ import annotations -from typing import List +from typing import Literal +from typing import Optional from typing import cast from pydantic import BaseModel -from foundry.v1.models._language_model import LanguageModel -from foundry.v1.models._list_language_models_response_dict import ( - ListLanguageModelsResponseDict, +from foundry.v1.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, ) # NOQA +from foundry.v1.models._order_by_direction import OrderByDirection +from foundry.v1.models._property_api_name import PropertyApiName -class ListLanguageModelsResponse(BaseModel): - """ListLanguageModelsResponse""" +class ExactDistinctAggregationV2(BaseModel): + """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - data: List[LanguageModel] - """The list of language models.""" + field: PropertyApiName + + name: Optional[AggregationMetricName] = None + + direction: Optional[OrderByDirection] = None + + type: Literal["exactDistinct"] model_config = {"extra": "allow"} - def to_dict(self) -> ListLanguageModelsResponseDict: + def to_dict(self) -> ExactDistinctAggregationV2Dict: """Return the dictionary representation of the model using the field aliases.""" return cast( - ListLanguageModelsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ExactDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True) ) diff --git a/foundry/v2/models/_chat_message_dict.py b/foundry/v1/models/_exact_distinct_aggregation_v2_dict.py similarity index 56% rename from foundry/v2/models/_chat_message_dict.py rename to foundry/v1/models/_exact_distinct_aggregation_v2_dict.py index a0684b603..72be3536f 100644 --- a/foundry/v2/models/_chat_message_dict.py +++ b/foundry/v1/models/_exact_distinct_aggregation_v2_dict.py @@ -15,18 +15,25 @@ from __future__ import annotations -from pydantic import StrictStr +from typing import Literal + from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._chat_message_role import ChatMessageRole +from foundry.v1.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.models._order_by_direction import OrderByDirection +from foundry.v1.models._property_api_name import PropertyApiName -class ChatMessageDict(TypedDict): - """ChatMessage""" +class ExactDistinctAggregationV2Dict(TypedDict): + """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - role: ChatMessageRole + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] - content: NotRequired[StrictStr] + type: Literal["exactDistinct"] diff --git a/foundry/v1/models/_object_set_stream_subscribe_request.py b/foundry/v1/models/_object_set_stream_subscribe_request.py index 2487bc6ac..331d3d284 100644 --- a/foundry/v1/models/_object_set_stream_subscribe_request.py +++ b/foundry/v1/models/_object_set_stream_subscribe_request.py @@ -16,7 +16,6 @@ from __future__ import annotations from typing import List -from typing import Optional from typing import cast from pydantic import BaseModel @@ -26,15 +25,12 @@ from foundry.v1.models._object_set_stream_subscribe_request_dict import ( ObjectSetStreamSubscribeRequestDict, ) # NOQA -from foundry.v1.models._ontology_identifier import OntologyIdentifier from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName class ObjectSetStreamSubscribeRequest(BaseModel): """ObjectSetStreamSubscribeRequest""" - ontology: Optional[OntologyIdentifier] = None - object_set: ObjectSet = Field(alias="objectSet") property_set: List[SelectedPropertyApiName] = Field(alias="propertySet") diff --git a/foundry/v1/models/_object_set_stream_subscribe_request_dict.py b/foundry/v1/models/_object_set_stream_subscribe_request_dict.py index 3833fd20d..103195dec 100644 --- a/foundry/v1/models/_object_set_stream_subscribe_request_dict.py +++ b/foundry/v1/models/_object_set_stream_subscribe_request_dict.py @@ -17,11 +17,9 @@ from typing import List -from typing_extensions import NotRequired from typing_extensions import TypedDict from foundry.v1.models._object_set_dict import ObjectSetDict -from foundry.v1.models._ontology_identifier import OntologyIdentifier from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName @@ -30,8 +28,6 @@ class ObjectSetStreamSubscribeRequestDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - ontology: NotRequired[OntologyIdentifier] - objectSet: ObjectSetDict propertySet: List[SelectedPropertyApiName] diff --git a/foundry/v1/models/_parameter_value.py b/foundry/v1/models/_parameter_value.py deleted file mode 100644 index 6fe850acf..000000000 --- a/foundry/v1/models/_parameter_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -ParameterValue = Any -"""ParameterValue""" diff --git a/foundry/v1/models/_reference_update.py b/foundry/v1/models/_reference_update.py index fcab2ebd5..03221d8ee 100644 --- a/foundry/v1/models/_reference_update.py +++ b/foundry/v1/models/_reference_update.py @@ -35,11 +35,11 @@ class ReferenceUpdate(BaseModel): field returns a dereferenced value rather than the reference itself. """ - api_name: ObjectTypeApiName = Field(alias="apiName") + object_type: ObjectTypeApiName = Field(alias="objectType") primary_key: ObjectPrimaryKey = Field(alias="primaryKey") - property_api_name: PropertyApiName = Field(alias="propertyApiName") + property: PropertyApiName value: ReferenceValue diff --git a/foundry/v1/models/_reference_update_dict.py b/foundry/v1/models/_reference_update_dict.py index d44443164..577439bbe 100644 --- a/foundry/v1/models/_reference_update_dict.py +++ b/foundry/v1/models/_reference_update_dict.py @@ -34,11 +34,11 @@ class ReferenceUpdateDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - apiName: ObjectTypeApiName + objectType: ObjectTypeApiName primaryKey: ObjectPrimaryKey - propertyApiName: PropertyApiName + property: PropertyApiName value: ReferenceValueDict diff --git a/foundry/v1/models/_search_objects_for_interface_request.py b/foundry/v1/models/_search_objects_for_interface_request.py index e16b2b62a..f8309579d 100644 --- a/foundry/v1/models/_search_objects_for_interface_request.py +++ b/foundry/v1/models/_search_objects_for_interface_request.py @@ -52,9 +52,9 @@ class SearchObjectsForInterfaceRequest(BaseModel): of properties specified in the value. """ - augmented_shared_property_types: Dict[ - InterfaceTypeApiName, List[SharedPropertyTypeApiName] - ] = Field(alias="augmentedSharedPropertyTypes") + augmented_shared_property_types: Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] = ( + Field(alias="augmentedSharedPropertyTypes") + ) """ A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object diff --git a/foundry/v2/_namespaces/orchestration/build.py b/foundry/v2/_namespaces/orchestration/build.py index 105c75d09..adb31fc2f 100644 --- a/foundry/v2/_namespaces/orchestration/build.py +++ b/foundry/v2/_namespaces/orchestration/build.py @@ -19,6 +19,7 @@ from typing import Any from typing import Dict from typing import Optional +from typing import Union from pydantic import Field from pydantic import StrictInt @@ -29,6 +30,8 @@ from foundry.api_client import RequestInfo from foundry.v2.models._build import Build from foundry.v2.models._build_rid import BuildRid +from foundry.v2.models._create_builds_request import CreateBuildsRequest +from foundry.v2.models._create_builds_request_dict import CreateBuildsRequestDict from foundry.v2.models._preview_mode import PreviewMode @@ -36,6 +39,51 @@ class BuildResource: def __init__(self, api_client: ApiClient) -> None: self._api_client = api_client + @validate_call + @handle_unexpected + def create( + self, + create_builds_request: Union[CreateBuildsRequest, CreateBuildsRequestDict], + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Build: + """ + + :param create_builds_request: Body of the request + :type create_builds_request: Union[CreateBuildsRequest, CreateBuildsRequestDict] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Build + """ + + _path_params: Dict[str, Any] = {} + _query_params: Dict[str, Any] = {} + _header_params: Dict[str, Any] = {} + _body_params: Any = create_builds_request + _query_params["preview"] = preview + + _header_params["Content-Type"] = "application/json" + + _header_params["Accept"] = "application/json" + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/builds/create", + query_params=_query_params, + path_params=_path_params, + header_params=_header_params, + body=_body_params, + body_type=Union[CreateBuildsRequest, CreateBuildsRequestDict], + response_type=Build, + request_timeout=request_timeout, + ), + ) + @validate_call @handle_unexpected def get( diff --git a/foundry/v2/_namespaces/orchestration/schedule.py b/foundry/v2/_namespaces/orchestration/schedule.py index 7b4aa2202..9b03ec247 100644 --- a/foundry/v2/_namespaces/orchestration/schedule.py +++ b/foundry/v2/_namespaces/orchestration/schedule.py @@ -30,6 +30,7 @@ from foundry.v2.models._preview_mode import PreviewMode from foundry.v2.models._schedule import Schedule from foundry.v2.models._schedule_rid import ScheduleRid +from foundry.v2.models._schedule_run import ScheduleRun class ScheduleResource: @@ -80,3 +81,134 @@ def get( request_timeout=request_timeout, ), ) + + @validate_call + @handle_unexpected + def pause( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + _path_params: Dict[str, Any] = {} + _query_params: Dict[str, Any] = {} + _header_params: Dict[str, Any] = {} + _body_params: Any = None + _query_params["preview"] = preview + + _path_params["scheduleRid"] = schedule_rid + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/schedules/{scheduleRid}/pause", + query_params=_query_params, + path_params=_path_params, + header_params=_header_params, + body=_body_params, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def run( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ScheduleRun: + """ + + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ScheduleRun + """ + + _path_params: Dict[str, Any] = {} + _query_params: Dict[str, Any] = {} + _header_params: Dict[str, Any] = {} + _body_params: Any = None + _query_params["preview"] = preview + + _path_params["scheduleRid"] = schedule_rid + + _header_params["Accept"] = "application/json" + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/schedules/{scheduleRid}/run", + query_params=_query_params, + path_params=_path_params, + header_params=_header_params, + body=_body_params, + body_type=None, + response_type=ScheduleRun, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def unpause( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + _path_params: Dict[str, Any] = {} + _query_params: Dict[str, Any] = {} + _header_params: Dict[str, Any] = {} + _body_params: Any = None + _query_params["preview"] = preview + + _path_params["scheduleRid"] = schedule_rid + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/schedules/{scheduleRid}/unpause", + query_params=_query_params, + path_params=_path_params, + header_params=_header_params, + body=_body_params, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/cli.py b/foundry/v2/cli.py index aab8fcaea..8ba7b9c51 100644 --- a/foundry/v2/cli.py +++ b/foundry/v2/cli.py @@ -2883,11 +2883,111 @@ def orchestration_schedule_get( click.echo(repr(result)) +@orchestration_schedule.command("pause") +@click.argument("schedule_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def orchestration_schedule_pause( + client: foundry.v2.FoundryV2Client, + schedule_rid: str, + preview: Optional[bool], +): + """ """ + result = client.orchestration.Schedule.pause( + schedule_rid=schedule_rid, + preview=preview, + ) + click.echo(repr(result)) + + +@orchestration_schedule.command("run") +@click.argument("schedule_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def orchestration_schedule_run( + client: foundry.v2.FoundryV2Client, + schedule_rid: str, + preview: Optional[bool], +): + """ """ + result = client.orchestration.Schedule.run( + schedule_rid=schedule_rid, + preview=preview, + ) + click.echo(repr(result)) + + +@orchestration_schedule.command("unpause") +@click.argument("schedule_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def orchestration_schedule_unpause( + client: foundry.v2.FoundryV2Client, + schedule_rid: str, + preview: Optional[bool], +): + """ """ + result = client.orchestration.Schedule.unpause( + schedule_rid=schedule_rid, + preview=preview, + ) + click.echo(repr(result)) + + @orchestration.group("build") def orchestration_build(): pass +@orchestration_build.command("create") +@click.option("--target", type=str, required=True, help="""The targets of the schedule.""") +@click.option( + "--branch_name", type=str, required=False, help="""The target branch the build should run on.""" +) +@click.option("--fallback_branches", type=str, required=True, help="""""") +@click.option("--force_build", type=bool, required=False, help="""""") +@click.option( + "--retry_count", + type=int, + required=False, + help="""The number of retry attempts for failed jobs.""", +) +@click.option("--retry_backoff_duration", type=str, required=False, help="""""") +@click.option("--abort_on_failure", type=bool, required=False, help="""""") +@click.option("--notifications_enabled", type=bool, required=False, help="""""") +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def orchestration_build_create( + client: foundry.v2.FoundryV2Client, + target: str, + branch_name: Optional[str], + fallback_branches: str, + force_build: Optional[bool], + retry_count: Optional[int], + retry_backoff_duration: Optional[str], + abort_on_failure: Optional[bool], + notifications_enabled: Optional[bool], + preview: Optional[bool], +): + """ """ + result = client.orchestration.Build.create( + create_builds_request=foundry.v2.models.CreateBuildsRequest.model_validate( + { + "target": target, + "branchName": branch_name, + "fallbackBranches": fallback_branches, + "forceBuild": force_build, + "retryCount": retry_count, + "retryBackoffDuration": retry_backoff_duration, + "abortOnFailure": abort_on_failure, + "notificationsEnabled": notifications_enabled, + } + ), + preview=preview, + ) + click.echo(repr(result)) + + @orchestration_build.command("get") @click.argument("build_rid", type=str, required=True) @click.option("--preview", type=bool, required=False, help="""preview""") diff --git a/foundry/v2/models/__init__.py b/foundry/v2/models/__init__.py index 6b6e4be1c..6a6d867f1 100644 --- a/foundry/v2/models/__init__.py +++ b/foundry/v2/models/__init__.py @@ -267,15 +267,6 @@ from foundry.v2.models._center_point_dict import CenterPointDict from foundry.v2.models._center_point_types import CenterPointTypes from foundry.v2.models._center_point_types_dict import CenterPointTypesDict -from foundry.v2.models._chat_completion_choice import ChatCompletionChoice -from foundry.v2.models._chat_completion_choice_dict import ChatCompletionChoiceDict -from foundry.v2.models._chat_completion_request import ChatCompletionRequest -from foundry.v2.models._chat_completion_request_dict import ChatCompletionRequestDict -from foundry.v2.models._chat_completion_response import ChatCompletionResponse -from foundry.v2.models._chat_completion_response_dict import ChatCompletionResponseDict -from foundry.v2.models._chat_message import ChatMessage -from foundry.v2.models._chat_message_dict import ChatMessageDict -from foundry.v2.models._chat_message_role import ChatMessageRole from foundry.v2.models._connecting_target import ConnectingTarget from foundry.v2.models._connecting_target_dict import ConnectingTargetDict from foundry.v2.models._contains_all_terms_in_order_prefix_last_term import ( @@ -309,6 +300,8 @@ from foundry.v2.models._count_objects_response_v2_dict import CountObjectsResponseV2Dict from foundry.v2.models._create_branch_request import CreateBranchRequest from foundry.v2.models._create_branch_request_dict import CreateBranchRequestDict +from foundry.v2.models._create_builds_request import CreateBuildsRequest +from foundry.v2.models._create_builds_request_dict import CreateBuildsRequestDict from foundry.v2.models._create_dataset_request import CreateDatasetRequest from foundry.v2.models._create_dataset_request_dict import CreateDatasetRequestDict from foundry.v2.models._create_group_request import CreateGroupRequest @@ -377,6 +370,10 @@ from foundry.v2.models._error import Error from foundry.v2.models._error_dict import ErrorDict from foundry.v2.models._error_name import ErrorName +from foundry.v2.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 +from foundry.v2.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, +) # NOQA from foundry.v2.models._execute_query_request import ExecuteQueryRequest from foundry.v2.models._execute_query_request_dict import ExecuteQueryRequestDict from foundry.v2.models._execute_query_response import ExecuteQueryResponse @@ -400,6 +397,8 @@ from foundry.v2.models._filter_value import FilterValue from foundry.v2.models._float_type import FloatType from foundry.v2.models._float_type_dict import FloatTypeDict +from foundry.v2.models._folder import Folder +from foundry.v2.models._folder_dict import FolderDict from foundry.v2.models._folder_rid import FolderRid from foundry.v2.models._force_build import ForceBuild from foundry.v2.models._function_rid import FunctionRid @@ -484,10 +483,6 @@ from foundry.v2.models._is_null_query_v2_dict import IsNullQueryV2Dict from foundry.v2.models._job_succeeded_trigger import JobSucceededTrigger from foundry.v2.models._job_succeeded_trigger_dict import JobSucceededTriggerDict -from foundry.v2.models._language_model import LanguageModel -from foundry.v2.models._language_model_api_name import LanguageModelApiName -from foundry.v2.models._language_model_dict import LanguageModelDict -from foundry.v2.models._language_model_source import LanguageModelSource from foundry.v2.models._line_string import LineString from foundry.v2.models._line_string_coordinates import LineStringCoordinates from foundry.v2.models._line_string_dict import LineStringDict @@ -533,10 +528,6 @@ from foundry.v2.models._list_interface_types_response_dict import ( ListInterfaceTypesResponseDict, ) # NOQA -from foundry.v2.models._list_language_models_response import ListLanguageModelsResponse -from foundry.v2.models._list_language_models_response_dict import ( - ListLanguageModelsResponseDict, -) # NOQA from foundry.v2.models._list_linked_objects_response import ListLinkedObjectsResponse from foundry.v2.models._list_linked_objects_response_dict import ( ListLinkedObjectsResponseDict, @@ -761,10 +752,8 @@ ParameterEvaluationResultDict, ) # NOQA from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._parameter_key import ParameterKey from foundry.v2.models._parameter_option import ParameterOption from foundry.v2.models._parameter_option_dict import ParameterOptionDict -from foundry.v2.models._parameter_value import ParameterValue from foundry.v2.models._phrase_query import PhraseQuery from foundry.v2.models._phrase_query_dict import PhraseQueryDict from foundry.v2.models._polygon import Polygon @@ -779,6 +768,8 @@ from foundry.v2.models._principal_filter_type import PrincipalFilterType from foundry.v2.models._principal_id import PrincipalId from foundry.v2.models._principal_type import PrincipalType +from foundry.v2.models._project import Project +from foundry.v2.models._project_dict import ProjectDict from foundry.v2.models._project_rid import ProjectRid from foundry.v2.models._project_scope import ProjectScope from foundry.v2.models._project_scope_dict import ProjectScopeDict @@ -869,7 +860,12 @@ RemoveGroupMembersRequestDict, ) # NOQA from foundry.v2.models._request_id import RequestId +from foundry.v2.models._resource import Resource +from foundry.v2.models._resource_dict import ResourceDict +from foundry.v2.models._resource_display_name import ResourceDisplayName from foundry.v2.models._resource_path import ResourcePath +from foundry.v2.models._resource_rid import ResourceRid +from foundry.v2.models._resource_type import ResourceType from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict from foundry.v2.models._retry_count import RetryCount @@ -878,6 +874,18 @@ from foundry.v2.models._schedule_dict import ScheduleDict from foundry.v2.models._schedule_paused import SchedulePaused from foundry.v2.models._schedule_rid import ScheduleRid +from foundry.v2.models._schedule_run import ScheduleRun +from foundry.v2.models._schedule_run_dict import ScheduleRunDict +from foundry.v2.models._schedule_run_error import ScheduleRunError +from foundry.v2.models._schedule_run_error_dict import ScheduleRunErrorDict +from foundry.v2.models._schedule_run_error_name import ScheduleRunErrorName +from foundry.v2.models._schedule_run_ignored import ScheduleRunIgnored +from foundry.v2.models._schedule_run_ignored_dict import ScheduleRunIgnoredDict +from foundry.v2.models._schedule_run_result import ScheduleRunResult +from foundry.v2.models._schedule_run_result_dict import ScheduleRunResultDict +from foundry.v2.models._schedule_run_rid import ScheduleRunRid +from foundry.v2.models._schedule_run_submitted import ScheduleRunSubmitted +from foundry.v2.models._schedule_run_submitted_dict import ScheduleRunSubmittedDict from foundry.v2.models._schedule_succeeded_trigger import ScheduleSucceededTrigger from foundry.v2.models._schedule_succeeded_trigger_dict import ScheduleSucceededTriggerDict # NOQA from foundry.v2.models._schedule_version import ScheduleVersion @@ -940,6 +948,9 @@ from foundry.v2.models._short_type import ShortType from foundry.v2.models._short_type_dict import ShortTypeDict from foundry.v2.models._size_bytes import SizeBytes +from foundry.v2.models._space import Space +from foundry.v2.models._space_dict import SpaceDict +from foundry.v2.models._space_rid import SpaceRid from foundry.v2.models._starts_with_query import StartsWithQuery from foundry.v2.models._starts_with_query_dict import StartsWithQueryDict from foundry.v2.models._stream_message import StreamMessage @@ -1015,6 +1026,7 @@ from foundry.v2.models._transaction_rid import TransactionRid from foundry.v2.models._transaction_status import TransactionStatus from foundry.v2.models._transaction_type import TransactionType +from foundry.v2.models._trashed_status import TrashedStatus from foundry.v2.models._trigger import AndTrigger from foundry.v2.models._trigger import OrTrigger from foundry.v2.models._trigger import Trigger @@ -1253,15 +1265,6 @@ "CenterPointDict", "CenterPointTypes", "CenterPointTypesDict", - "ChatCompletionChoice", - "ChatCompletionChoiceDict", - "ChatCompletionRequest", - "ChatCompletionRequestDict", - "ChatCompletionResponse", - "ChatCompletionResponseDict", - "ChatMessage", - "ChatMessageDict", - "ChatMessageRole", "ConnectingTarget", "ConnectingTargetDict", "ContainsAllTermsInOrderPrefixLastTerm", @@ -1287,6 +1290,8 @@ "CountObjectsResponseV2Dict", "CreateBranchRequest", "CreateBranchRequestDict", + "CreateBuildsRequest", + "CreateBuildsRequestDict", "CreateDatasetRequest", "CreateDatasetRequestDict", "CreatedBy", @@ -1341,6 +1346,8 @@ "Error", "ErrorDict", "ErrorName", + "ExactDistinctAggregationV2", + "ExactDistinctAggregationV2Dict", "ExecuteQueryRequest", "ExecuteQueryRequestDict", "ExecuteQueryResponse", @@ -1364,6 +1371,8 @@ "FilterValue", "FloatType", "FloatTypeDict", + "Folder", + "FolderDict", "FolderRid", "ForceBuild", "FunctionRid", @@ -1438,10 +1447,6 @@ "IsNullQueryV2Dict", "JobSucceededTrigger", "JobSucceededTriggerDict", - "LanguageModel", - "LanguageModelApiName", - "LanguageModelDict", - "LanguageModelSource", "LinearRing", "LineString", "LineStringCoordinates", @@ -1477,8 +1482,6 @@ "ListGroupsResponseDict", "ListInterfaceTypesResponse", "ListInterfaceTypesResponseDict", - "ListLanguageModelsResponse", - "ListLanguageModelsResponseDict", "ListLinkedObjectsResponse", "ListLinkedObjectsResponseDict", "ListLinkedObjectsResponseV2", @@ -1671,10 +1674,8 @@ "ParameterEvaluationResult", "ParameterEvaluationResultDict", "ParameterId", - "ParameterKey", "ParameterOption", "ParameterOptionDict", - "ParameterValue", "PhraseQuery", "PhraseQueryDict", "Polygon", @@ -1689,6 +1690,8 @@ "PrincipalFilterType", "PrincipalId", "PrincipalType", + "Project", + "ProjectDict", "ProjectRid", "ProjectScope", "ProjectScopeDict", @@ -1763,7 +1766,12 @@ "RemoveGroupMembersRequest", "RemoveGroupMembersRequestDict", "RequestId", + "Resource", + "ResourceDict", + "ResourceDisplayName", "ResourcePath", + "ResourceRid", + "ResourceType", "RetryBackoffDuration", "RetryBackoffDurationDict", "RetryCount", @@ -1772,6 +1780,18 @@ "ScheduleDict", "SchedulePaused", "ScheduleRid", + "ScheduleRun", + "ScheduleRunDict", + "ScheduleRunError", + "ScheduleRunErrorDict", + "ScheduleRunErrorName", + "ScheduleRunIgnored", + "ScheduleRunIgnoredDict", + "ScheduleRunResult", + "ScheduleRunResultDict", + "ScheduleRunRid", + "ScheduleRunSubmitted", + "ScheduleRunSubmittedDict", "ScheduleSucceededTrigger", "ScheduleSucceededTriggerDict", "ScheduleVersion", @@ -1818,6 +1838,9 @@ "ShortType", "ShortTypeDict", "SizeBytes", + "Space", + "SpaceDict", + "SpaceRid", "StartsWithQuery", "StartsWithQueryDict", "StreamMessage", @@ -1877,6 +1900,7 @@ "TransactionRid", "TransactionStatus", "TransactionType", + "TrashedStatus", "Trigger", "TriggerDict", "TwoDimensionalAggregation", diff --git a/foundry/v2/models/_aggregation_v2.py b/foundry/v2/models/_aggregation_v2.py index 3fcfcb9ff..a4a3690ac 100644 --- a/foundry/v2/models/_aggregation_v2.py +++ b/foundry/v2/models/_aggregation_v2.py @@ -28,6 +28,7 @@ ) # NOQA from foundry.v2.models._avg_aggregation_v2 import AvgAggregationV2 from foundry.v2.models._count_aggregation_v2 import CountAggregationV2 +from foundry.v2.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 from foundry.v2.models._max_aggregation_v2 import MaxAggregationV2 from foundry.v2.models._min_aggregation_v2 import MinAggregationV2 from foundry.v2.models._sum_aggregation_v2 import SumAggregationV2 @@ -41,6 +42,7 @@ CountAggregationV2, ApproximateDistinctAggregationV2, ApproximatePercentileAggregationV2, + ExactDistinctAggregationV2, ], Field(discriminator="type"), ] diff --git a/foundry/v2/models/_aggregation_v2_dict.py b/foundry/v2/models/_aggregation_v2_dict.py index baa344064..2d753edda 100644 --- a/foundry/v2/models/_aggregation_v2_dict.py +++ b/foundry/v2/models/_aggregation_v2_dict.py @@ -28,6 +28,9 @@ ) # NOQA from foundry.v2.models._avg_aggregation_v2_dict import AvgAggregationV2Dict from foundry.v2.models._count_aggregation_v2_dict import CountAggregationV2Dict +from foundry.v2.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, +) # NOQA from foundry.v2.models._max_aggregation_v2_dict import MaxAggregationV2Dict from foundry.v2.models._min_aggregation_v2_dict import MinAggregationV2Dict from foundry.v2.models._sum_aggregation_v2_dict import SumAggregationV2Dict @@ -41,6 +44,7 @@ CountAggregationV2Dict, ApproximateDistinctAggregationV2Dict, ApproximatePercentileAggregationV2Dict, + ExactDistinctAggregationV2Dict, ], Field(discriminator="type"), ] diff --git a/foundry/v2/models/_approximate_percentile_aggregation_v2.py b/foundry/v2/models/_approximate_percentile_aggregation_v2.py index 017d56c3c..7d9aa4512 100644 --- a/foundry/v2/models/_approximate_percentile_aggregation_v2.py +++ b/foundry/v2/models/_approximate_percentile_aggregation_v2.py @@ -32,7 +32,7 @@ class ApproximatePercentileAggregationV2(BaseModel): - """Computes the approximate percentile value for the provided field.""" + """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" field: PropertyApiName diff --git a/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py b/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py index 3fd2879ee..35de4a94e 100644 --- a/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py +++ b/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py @@ -27,7 +27,7 @@ class ApproximatePercentileAggregationV2Dict(TypedDict): - """Computes the approximate percentile value for the provided field.""" + """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_build.py b/foundry/v2/models/_build.py index 59dca31f5..5a6a89276 100644 --- a/foundry/v2/models/_build.py +++ b/foundry/v2/models/_build.py @@ -21,11 +21,13 @@ from pydantic import Field from foundry.v2.models._abort_on_failure import AbortOnFailure +from foundry.v2.models._branch_name import BranchName from foundry.v2.models._build_dict import BuildDict from foundry.v2.models._build_rid import BuildRid from foundry.v2.models._build_status import BuildStatus from foundry.v2.models._created_by import CreatedBy from foundry.v2.models._created_time import CreatedTime +from foundry.v2.models._fallback_branches import FallbackBranches from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration from foundry.v2.models._retry_count import RetryCount @@ -36,12 +38,17 @@ class Build(BaseModel): rid: BuildRid """The RID of a build""" + branch_name: BranchName = Field(alias="branchName") + """The branch that the build is running on.""" + created_time: CreatedTime = Field(alias="createdTime") """The timestamp that the build was created.""" created_by: CreatedBy = Field(alias="createdBy") """The user who created the build.""" + fallback_branches: FallbackBranches = Field(alias="fallbackBranches") + retry_count: RetryCount = Field(alias="retryCount") retry_backoff_duration: RetryBackoffDuration = Field(alias="retryBackoffDuration") diff --git a/foundry/v2/models/_build_dict.py b/foundry/v2/models/_build_dict.py index b44619621..e353efbc5 100644 --- a/foundry/v2/models/_build_dict.py +++ b/foundry/v2/models/_build_dict.py @@ -18,10 +18,12 @@ from typing_extensions import TypedDict from foundry.v2.models._abort_on_failure import AbortOnFailure +from foundry.v2.models._branch_name import BranchName from foundry.v2.models._build_rid import BuildRid from foundry.v2.models._build_status import BuildStatus from foundry.v2.models._created_by import CreatedBy from foundry.v2.models._created_time import CreatedTime +from foundry.v2.models._fallback_branches import FallbackBranches from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict from foundry.v2.models._retry_count import RetryCount @@ -34,12 +36,17 @@ class BuildDict(TypedDict): rid: BuildRid """The RID of a build""" + branchName: BranchName + """The branch that the build is running on.""" + createdTime: CreatedTime """The timestamp that the build was created.""" createdBy: CreatedBy """The user who created the build.""" + fallbackBranches: FallbackBranches + retryCount: RetryCount retryBackoffDuration: RetryBackoffDurationDict diff --git a/foundry/v2/models/_chat_completion_request.py b/foundry/v2/models/_chat_completion_request.py deleted file mode 100644 index 2e87fc7bf..000000000 --- a/foundry/v2/models/_chat_completion_request.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._chat_completion_request_dict import ChatCompletionRequestDict -from foundry.v2.models._chat_message import ChatMessage -from foundry.v2.models._parameter_key import ParameterKey -from foundry.v2.models._parameter_value import ParameterValue - - -class ChatCompletionRequest(BaseModel): - """ChatCompletionRequest""" - - messages: List[ChatMessage] - - parameters: Dict[ParameterKey, ParameterValue] - """ - Any additional model-specific parameters: - - for global models, the keys can be one of the following - (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - - `temperature` - - `top_p` - - `n` - - `stop` - - `max_tokens` - - `presence_penalty` - - `frequency_penalty` - - `logit_bias` - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> ChatCompletionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatCompletionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_chat_completion_request_dict.py b/foundry/v2/models/_chat_completion_request_dict.py deleted file mode 100644 index 26a97d790..000000000 --- a/foundry/v2/models/_chat_completion_request_dict.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._chat_message_dict import ChatMessageDict -from foundry.v2.models._parameter_key import ParameterKey -from foundry.v2.models._parameter_value import ParameterValue - - -class ChatCompletionRequestDict(TypedDict): - """ChatCompletionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - messages: List[ChatMessageDict] - - parameters: Dict[ParameterKey, ParameterValue] - """ - Any additional model-specific parameters: - - for global models, the keys can be one of the following - (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - - `temperature` - - `top_p` - - `n` - - `stop` - - `max_tokens` - - `presence_penalty` - - `frequency_penalty` - - `logit_bias` - """ diff --git a/foundry/v2/models/_chat_completion_response.py b/foundry/v2/models/_chat_completion_response.py deleted file mode 100644 index 7119a0d73..000000000 --- a/foundry/v2/models/_chat_completion_response.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._chat_completion_choice import ChatCompletionChoice -from foundry.v2.models._chat_completion_response_dict import ChatCompletionResponseDict - - -class ChatCompletionResponse(BaseModel): - """Contains `n` different completion choices as specified in the request parameter.""" - - choices: List[ChatCompletionChoice] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ChatCompletionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatCompletionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_chat_completion_response_dict.py b/foundry/v2/models/_chat_completion_response_dict.py deleted file mode 100644 index d5e332194..000000000 --- a/foundry/v2/models/_chat_completion_response_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._chat_completion_choice_dict import ChatCompletionChoiceDict - - -class ChatCompletionResponseDict(TypedDict): - """Contains `n` different completion choices as specified in the request parameter.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - choices: List[ChatCompletionChoiceDict] diff --git a/foundry/v2/models/_create_builds_request.py b/foundry/v2/models/_create_builds_request.py new file mode 100644 index 000000000..1b68c6db0 --- /dev/null +++ b/foundry/v2/models/_create_builds_request.py @@ -0,0 +1,65 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.models._abort_on_failure import AbortOnFailure +from foundry.v2.models._branch_name import BranchName +from foundry.v2.models._build_target import BuildTarget +from foundry.v2.models._create_builds_request_dict import CreateBuildsRequestDict +from foundry.v2.models._fallback_branches import FallbackBranches +from foundry.v2.models._force_build import ForceBuild +from foundry.v2.models._notifications_enabled import NotificationsEnabled +from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration +from foundry.v2.models._retry_count import RetryCount + + +class CreateBuildsRequest(BaseModel): + """CreateBuildsRequest""" + + target: BuildTarget + """The targets of the schedule.""" + + branch_name: Optional[BranchName] = Field(alias="branchName", default=None) + """The target branch the build should run on.""" + + fallback_branches: FallbackBranches = Field(alias="fallbackBranches") + + force_build: Optional[ForceBuild] = Field(alias="forceBuild", default=None) + + retry_count: Optional[RetryCount] = Field(alias="retryCount", default=None) + """The number of retry attempts for failed jobs.""" + + retry_backoff_duration: Optional[RetryBackoffDuration] = Field( + alias="retryBackoffDuration", default=None + ) + + abort_on_failure: Optional[AbortOnFailure] = Field(alias="abortOnFailure", default=None) + + notifications_enabled: Optional[NotificationsEnabled] = Field( + alias="notificationsEnabled", default=None + ) + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateBuildsRequestDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CreateBuildsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_builds_request_dict.py b/foundry/v2/models/_create_builds_request_dict.py new file mode 100644 index 000000000..c93f2bd0a --- /dev/null +++ b/foundry/v2/models/_create_builds_request_dict.py @@ -0,0 +1,53 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.models._abort_on_failure import AbortOnFailure +from foundry.v2.models._branch_name import BranchName +from foundry.v2.models._build_target_dict import BuildTargetDict +from foundry.v2.models._fallback_branches import FallbackBranches +from foundry.v2.models._force_build import ForceBuild +from foundry.v2.models._notifications_enabled import NotificationsEnabled +from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict +from foundry.v2.models._retry_count import RetryCount + + +class CreateBuildsRequestDict(TypedDict): + """CreateBuildsRequest""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + target: BuildTargetDict + """The targets of the schedule.""" + + branchName: NotRequired[BranchName] + """The target branch the build should run on.""" + + fallbackBranches: FallbackBranches + + forceBuild: NotRequired[ForceBuild] + + retryCount: NotRequired[RetryCount] + """The number of retry attempts for failed jobs.""" + + retryBackoffDuration: NotRequired[RetryBackoffDurationDict] + + abortOnFailure: NotRequired[AbortOnFailure] + + notificationsEnabled: NotRequired[NotificationsEnabled] diff --git a/foundry/v2/models/_duration.py b/foundry/v2/models/_duration.py index f2cac44fd..2b55cbd56 100644 --- a/foundry/v2/models/_duration.py +++ b/foundry/v2/models/_duration.py @@ -18,7 +18,7 @@ from typing import cast from pydantic import BaseModel -from pydantic import StrictFloat +from pydantic import StrictInt from foundry.v2.models._duration_dict import DurationDict from foundry.v2.models._time_unit import TimeUnit @@ -27,7 +27,7 @@ class Duration(BaseModel): """A measurement of duration.""" - value: StrictFloat + value: StrictInt """The duration value.""" unit: TimeUnit diff --git a/foundry/v2/models/_duration_dict.py b/foundry/v2/models/_duration_dict.py index 47e95144a..607026ff1 100644 --- a/foundry/v2/models/_duration_dict.py +++ b/foundry/v2/models/_duration_dict.py @@ -15,7 +15,7 @@ from __future__ import annotations -from pydantic import StrictFloat +from pydantic import StrictInt from typing_extensions import TypedDict from foundry.v2.models._time_unit import TimeUnit @@ -26,7 +26,7 @@ class DurationDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - value: StrictFloat + value: StrictInt """The duration value.""" unit: TimeUnit diff --git a/foundry/v2/models/_list_language_models_response.py b/foundry/v2/models/_exact_distinct_aggregation_v2.py similarity index 51% rename from foundry/v2/models/_list_language_models_response.py rename to foundry/v2/models/_exact_distinct_aggregation_v2.py index 12df048da..0148fe0c7 100644 --- a/foundry/v2/models/_list_language_models_response.py +++ b/foundry/v2/models/_exact_distinct_aggregation_v2.py @@ -15,27 +15,35 @@ from __future__ import annotations -from typing import List +from typing import Literal +from typing import Optional from typing import cast from pydantic import BaseModel -from foundry.v2.models._language_model import LanguageModel -from foundry.v2.models._list_language_models_response_dict import ( - ListLanguageModelsResponseDict, +from foundry.v2.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, ) # NOQA +from foundry.v2.models._order_by_direction import OrderByDirection +from foundry.v2.models._property_api_name import PropertyApiName -class ListLanguageModelsResponse(BaseModel): - """ListLanguageModelsResponse""" +class ExactDistinctAggregationV2(BaseModel): + """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - data: List[LanguageModel] - """The list of language models.""" + field: PropertyApiName + + name: Optional[AggregationMetricName] = None + + direction: Optional[OrderByDirection] = None + + type: Literal["exactDistinct"] model_config = {"extra": "allow"} - def to_dict(self) -> ListLanguageModelsResponseDict: + def to_dict(self) -> ExactDistinctAggregationV2Dict: """Return the dictionary representation of the model using the field aliases.""" return cast( - ListLanguageModelsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ExactDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True) ) diff --git a/foundry/v1/models/_language_model_dict.py b/foundry/v2/models/_exact_distinct_aggregation_v2_dict.py similarity index 56% rename from foundry/v1/models/_language_model_dict.py rename to foundry/v2/models/_exact_distinct_aggregation_v2_dict.py index 600a5fd0b..f559f5fcc 100644 --- a/foundry/v1/models/_language_model_dict.py +++ b/foundry/v2/models/_exact_distinct_aggregation_v2_dict.py @@ -15,18 +15,25 @@ from __future__ import annotations +from typing import Literal + from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v1.models._language_model_api_name import LanguageModelApiName -from foundry.v1.models._language_model_source import LanguageModelSource +from foundry.v2.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.models._order_by_direction import OrderByDirection +from foundry.v2.models._property_api_name import PropertyApiName -class LanguageModelDict(TypedDict): - """Represents a language model.""" +class ExactDistinctAggregationV2Dict(TypedDict): + """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - apiName: NotRequired[LanguageModelApiName] + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] - source: NotRequired[LanguageModelSource] + type: Literal["exactDistinct"] diff --git a/foundry/v1/models/_chat_completion_choice.py b/foundry/v2/models/_folder.py similarity index 65% rename from foundry/v1/models/_chat_completion_choice.py rename to foundry/v2/models/_folder.py index a207e6b6a..5083c1b64 100644 --- a/foundry/v1/models/_chat_completion_choice.py +++ b/foundry/v2/models/_folder.py @@ -15,22 +15,21 @@ from __future__ import annotations -from typing import Optional from typing import cast from pydantic import BaseModel -from foundry.v1.models._chat_completion_choice_dict import ChatCompletionChoiceDict -from foundry.v1.models._chat_message import ChatMessage +from foundry.v2.models._folder_dict import FolderDict +from foundry.v2.models._folder_rid import FolderRid -class ChatCompletionChoice(BaseModel): - """ChatCompletionChoice""" +class Folder(BaseModel): + """Folder""" - message: Optional[ChatMessage] = None + rid: FolderRid model_config = {"extra": "allow"} - def to_dict(self) -> ChatCompletionChoiceDict: + def to_dict(self) -> FolderDict: """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatCompletionChoiceDict, self.model_dump(by_alias=True, exclude_unset=True)) + return cast(FolderDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_chat_completion_choice_dict.py b/foundry/v2/models/_folder_dict.py similarity index 76% rename from foundry/v1/models/_chat_completion_choice_dict.py rename to foundry/v2/models/_folder_dict.py index 4fe5e9809..c0900ea67 100644 --- a/foundry/v1/models/_chat_completion_choice_dict.py +++ b/foundry/v2/models/_folder_dict.py @@ -15,15 +15,14 @@ from __future__ import annotations -from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v1.models._chat_message_dict import ChatMessageDict +from foundry.v2.models._folder_rid import FolderRid -class ChatCompletionChoiceDict(TypedDict): - """ChatCompletionChoice""" +class FolderDict(TypedDict): + """Folder""" __pydantic_config__ = {"extra": "allow"} # type: ignore - message: NotRequired[ChatMessageDict] + rid: FolderRid diff --git a/foundry/v2/models/_folder_rid.py b/foundry/v2/models/_folder_rid.py index aa8c43caa..eb5a26896 100644 --- a/foundry/v2/models/_folder_rid.py +++ b/foundry/v2/models/_folder_rid.py @@ -18,4 +18,4 @@ from foundry._core.utils import RID FolderRid = RID -"""FolderRid""" +"""The unique resource identifier (RID) of a Folder.""" diff --git a/foundry/v2/models/_language_model.py b/foundry/v2/models/_language_model.py deleted file mode 100644 index ef771ca72..000000000 --- a/foundry/v2/models/_language_model.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._language_model_api_name import LanguageModelApiName -from foundry.v2.models._language_model_dict import LanguageModelDict -from foundry.v2.models._language_model_source import LanguageModelSource - - -class LanguageModel(BaseModel): - """Represents a language model.""" - - api_name: Optional[LanguageModelApiName] = Field(alias="apiName", default=None) - - source: Optional[LanguageModelSource] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> LanguageModelDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LanguageModelDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_language_model_dict.py b/foundry/v2/models/_language_model_dict.py deleted file mode 100644 index 00fd56a55..000000000 --- a/foundry/v2/models/_language_model_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._language_model_api_name import LanguageModelApiName -from foundry.v2.models._language_model_source import LanguageModelSource - - -class LanguageModelDict(TypedDict): - """Represents a language model.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: NotRequired[LanguageModelApiName] - - source: NotRequired[LanguageModelSource] diff --git a/foundry/v2/models/_object_set_stream_subscribe_request.py b/foundry/v2/models/_object_set_stream_subscribe_request.py index 0d035827b..72ec57b4c 100644 --- a/foundry/v2/models/_object_set_stream_subscribe_request.py +++ b/foundry/v2/models/_object_set_stream_subscribe_request.py @@ -16,7 +16,6 @@ from __future__ import annotations from typing import List -from typing import Optional from typing import cast from pydantic import BaseModel @@ -26,15 +25,12 @@ from foundry.v2.models._object_set_stream_subscribe_request_dict import ( ObjectSetStreamSubscribeRequestDict, ) # NOQA -from foundry.v2.models._ontology_identifier import OntologyIdentifier from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName class ObjectSetStreamSubscribeRequest(BaseModel): """ObjectSetStreamSubscribeRequest""" - ontology: Optional[OntologyIdentifier] = None - object_set: ObjectSet = Field(alias="objectSet") property_set: List[SelectedPropertyApiName] = Field(alias="propertySet") diff --git a/foundry/v2/models/_object_set_stream_subscribe_request_dict.py b/foundry/v2/models/_object_set_stream_subscribe_request_dict.py index b4f11a4c8..a479de3f1 100644 --- a/foundry/v2/models/_object_set_stream_subscribe_request_dict.py +++ b/foundry/v2/models/_object_set_stream_subscribe_request_dict.py @@ -17,11 +17,9 @@ from typing import List -from typing_extensions import NotRequired from typing_extensions import TypedDict from foundry.v2.models._object_set_dict import ObjectSetDict -from foundry.v2.models._ontology_identifier import OntologyIdentifier from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName @@ -30,8 +28,6 @@ class ObjectSetStreamSubscribeRequestDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - ontology: NotRequired[OntologyIdentifier] - objectSet: ObjectSetDict propertySet: List[SelectedPropertyApiName] diff --git a/foundry/v2/models/_parameter_key.py b/foundry/v2/models/_parameter_key.py deleted file mode 100644 index a9627d806..000000000 --- a/foundry/v2/models/_parameter_key.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ParameterKey = StrictStr -"""The unique identifier of the model parameter.""" diff --git a/foundry/v2/models/_chat_completion_choice.py b/foundry/v2/models/_project.py similarity index 65% rename from foundry/v2/models/_chat_completion_choice.py rename to foundry/v2/models/_project.py index b872af6ea..391b65f7e 100644 --- a/foundry/v2/models/_chat_completion_choice.py +++ b/foundry/v2/models/_project.py @@ -15,22 +15,21 @@ from __future__ import annotations -from typing import Optional from typing import cast from pydantic import BaseModel -from foundry.v2.models._chat_completion_choice_dict import ChatCompletionChoiceDict -from foundry.v2.models._chat_message import ChatMessage +from foundry.v2.models._project_dict import ProjectDict +from foundry.v2.models._project_rid import ProjectRid -class ChatCompletionChoice(BaseModel): - """ChatCompletionChoice""" +class Project(BaseModel): + """Project""" - message: Optional[ChatMessage] = None + rid: ProjectRid model_config = {"extra": "allow"} - def to_dict(self) -> ChatCompletionChoiceDict: + def to_dict(self) -> ProjectDict: """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatCompletionChoiceDict, self.model_dump(by_alias=True, exclude_unset=True)) + return cast(ProjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_chat_completion_choice_dict.py b/foundry/v2/models/_project_dict.py similarity index 76% rename from foundry/v2/models/_chat_completion_choice_dict.py rename to foundry/v2/models/_project_dict.py index 0caa48c03..045a2c29e 100644 --- a/foundry/v2/models/_chat_completion_choice_dict.py +++ b/foundry/v2/models/_project_dict.py @@ -15,15 +15,14 @@ from __future__ import annotations -from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._chat_message_dict import ChatMessageDict +from foundry.v2.models._project_rid import ProjectRid -class ChatCompletionChoiceDict(TypedDict): - """ChatCompletionChoice""" +class ProjectDict(TypedDict): + """Project""" __pydantic_config__ = {"extra": "allow"} # type: ignore - message: NotRequired[ChatMessageDict] + rid: ProjectRid diff --git a/foundry/v2/models/_project_rid.py b/foundry/v2/models/_project_rid.py index b2ded6d9f..ec31c277c 100644 --- a/foundry/v2/models/_project_rid.py +++ b/foundry/v2/models/_project_rid.py @@ -18,4 +18,4 @@ from foundry._core.utils import RID ProjectRid = RID -"""The Resource Identifier (RID) of a Project.""" +"""The unique resource identifier (RID) of a Project.""" diff --git a/foundry/v2/models/_reference_update.py b/foundry/v2/models/_reference_update.py index 84f66927f..8a4060baf 100644 --- a/foundry/v2/models/_reference_update.py +++ b/foundry/v2/models/_reference_update.py @@ -35,11 +35,11 @@ class ReferenceUpdate(BaseModel): field returns a dereferenced value rather than the reference itself. """ - api_name: ObjectTypeApiName = Field(alias="apiName") + object_type: ObjectTypeApiName = Field(alias="objectType") primary_key: ObjectPrimaryKey = Field(alias="primaryKey") - property_api_name: PropertyApiName = Field(alias="propertyApiName") + property: PropertyApiName value: ReferenceValue diff --git a/foundry/v2/models/_reference_update_dict.py b/foundry/v2/models/_reference_update_dict.py index e449dc650..16e78cd4e 100644 --- a/foundry/v2/models/_reference_update_dict.py +++ b/foundry/v2/models/_reference_update_dict.py @@ -34,11 +34,11 @@ class ReferenceUpdateDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - apiName: ObjectTypeApiName + objectType: ObjectTypeApiName primaryKey: ObjectPrimaryKey - propertyApiName: PropertyApiName + property: PropertyApiName value: ReferenceValueDict diff --git a/foundry/v2/models/_resource.py b/foundry/v2/models/_resource.py new file mode 100644 index 000000000..98179ca37 --- /dev/null +++ b/foundry/v2/models/_resource.py @@ -0,0 +1,97 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.models._created_by import CreatedBy +from foundry.v2.models._created_time import CreatedTime +from foundry.v2.models._folder_rid import FolderRid +from foundry.v2.models._project_rid import ProjectRid +from foundry.v2.models._resource_dict import ResourceDict +from foundry.v2.models._resource_display_name import ResourceDisplayName +from foundry.v2.models._resource_path import ResourcePath +from foundry.v2.models._resource_rid import ResourceRid +from foundry.v2.models._resource_type import ResourceType +from foundry.v2.models._space_rid import SpaceRid +from foundry.v2.models._trashed_status import TrashedStatus +from foundry.v2.models._updated_by import UpdatedBy +from foundry.v2.models._updated_time import UpdatedTime + + +class Resource(BaseModel): + """Resource""" + + rid: ResourceRid + + display_name: ResourceDisplayName = Field(alias="displayName") + """The display name of the Resource""" + + description: Optional[StrictStr] = None + """The description of the Resource""" + + documentation: Optional[StrictStr] = None + """The documentation associated with the Resource""" + + path: ResourcePath + """The full path to the resource, including the resource name itself""" + + type: ResourceType + """The type of the Resource derived from the Resource Identifier (RID).""" + + created_by: CreatedBy = Field(alias="createdBy") + """The user that created the Resource.""" + + updated_by: UpdatedBy = Field(alias="updatedBy") + """The user that last updated the Resource.""" + + created_time: CreatedTime = Field(alias="createdTime") + """The timestamp that the Resource was last created.""" + + updated_time: UpdatedTime = Field(alias="updatedTime") + """ + The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For + top level folders (spaces and projects), this is not updated by child updates for performance reasons. + """ + + trashed: TrashedStatus + """ + The trash status of the resource. If trashed, a resource can either be directly trashed or one + of its ancestors can be trashed. + """ + + parent_folder_rid: FolderRid = Field(alias="parentFolderRid") + """The parent folder Resource Identifier (RID). For projects, this will be the Space RID.""" + + project_rid: ProjectRid = Field(alias="projectRid") + """ + The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a + Project, this value will still be populated with the Project RID. + """ + + space_rid: SpaceRid = Field(alias="spaceRid") + """The Space Resource Identifier (RID) that the Resource lives in.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ResourceDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ResourceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_resource_dict.py b/foundry/v2/models/_resource_dict.py new file mode 100644 index 000000000..479a8051e --- /dev/null +++ b/foundry/v2/models/_resource_dict.py @@ -0,0 +1,89 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.models._created_by import CreatedBy +from foundry.v2.models._created_time import CreatedTime +from foundry.v2.models._folder_rid import FolderRid +from foundry.v2.models._project_rid import ProjectRid +from foundry.v2.models._resource_display_name import ResourceDisplayName +from foundry.v2.models._resource_path import ResourcePath +from foundry.v2.models._resource_rid import ResourceRid +from foundry.v2.models._resource_type import ResourceType +from foundry.v2.models._space_rid import SpaceRid +from foundry.v2.models._trashed_status import TrashedStatus +from foundry.v2.models._updated_by import UpdatedBy +from foundry.v2.models._updated_time import UpdatedTime + + +class ResourceDict(TypedDict): + """Resource""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: ResourceRid + + displayName: ResourceDisplayName + """The display name of the Resource""" + + description: NotRequired[StrictStr] + """The description of the Resource""" + + documentation: NotRequired[StrictStr] + """The documentation associated with the Resource""" + + path: ResourcePath + """The full path to the resource, including the resource name itself""" + + type: ResourceType + """The type of the Resource derived from the Resource Identifier (RID).""" + + createdBy: CreatedBy + """The user that created the Resource.""" + + updatedBy: UpdatedBy + """The user that last updated the Resource.""" + + createdTime: CreatedTime + """The timestamp that the Resource was last created.""" + + updatedTime: UpdatedTime + """ + The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For + top level folders (spaces and projects), this is not updated by child updates for performance reasons. + """ + + trashed: TrashedStatus + """ + The trash status of the resource. If trashed, a resource can either be directly trashed or one + of its ancestors can be trashed. + """ + + parentFolderRid: FolderRid + """The parent folder Resource Identifier (RID). For projects, this will be the Space RID.""" + + projectRid: ProjectRid + """ + The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a + Project, this value will still be populated with the Project RID. + """ + + spaceRid: SpaceRid + """The Space Resource Identifier (RID) that the Resource lives in.""" diff --git a/foundry/v1/models/_parameter_key.py b/foundry/v2/models/_resource_display_name.py similarity index 89% rename from foundry/v1/models/_parameter_key.py rename to foundry/v2/models/_resource_display_name.py index a9627d806..fedc985c0 100644 --- a/foundry/v1/models/_parameter_key.py +++ b/foundry/v2/models/_resource_display_name.py @@ -17,5 +17,5 @@ from pydantic import StrictStr -ParameterKey = StrictStr -"""The unique identifier of the model parameter.""" +ResourceDisplayName = StrictStr +"""The display name of the Resource""" diff --git a/foundry/v2/models/_resource_path.py b/foundry/v2/models/_resource_path.py index 0b89bd010..092b57575 100644 --- a/foundry/v2/models/_resource_path.py +++ b/foundry/v2/models/_resource_path.py @@ -18,4 +18,4 @@ from pydantic import StrictStr ResourcePath = StrictStr -"""A path in the Foundry file tree.""" +"""The full path to the resource, including the resource name itself""" diff --git a/foundry/v1/models/_language_model_source.py b/foundry/v2/models/_resource_rid.py similarity index 85% rename from foundry/v1/models/_language_model_source.py rename to foundry/v2/models/_resource_rid.py index 6db27d115..75bb93528 100644 --- a/foundry/v1/models/_language_model_source.py +++ b/foundry/v2/models/_resource_rid.py @@ -15,7 +15,7 @@ from __future__ import annotations -from typing import Literal +from foundry._core.utils import RID -LanguageModelSource = Literal["global", "hosted"] -"""LanguageModelSource""" +ResourceRid = RID +"""The unique resource identifier (RID) of a Resource.""" diff --git a/foundry/v2/models/_resource_type.py b/foundry/v2/models/_resource_type.py new file mode 100644 index 000000000..62ae48666 --- /dev/null +++ b/foundry/v2/models/_resource_type.py @@ -0,0 +1,71 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +ResourceType = Literal[ + "Academy_Tutorial", + "Artifacts_Repository", + "Automate_Automation", + "Builder_Pipeline", + "Carbon_Workspace", + "Cipher_Channel", + "Code_Repository", + "Code_Workbook", + "Code_Workspace", + "Connectivity_Agent", + "Connectivity_Source", + "Connectivity_VirtualTable", + "Contour_Analysis", + "Data_Lineage_Graph", + "Datasets_Dataset", + "Filesystem_Document", + "Filesystem_Folder", + "Filesystem_Image", + "Filesystem_Project", + "Filesystem_Space", + "Filesystem_WebLink", + "Foundry_Form", + "Foundry_Report", + "Foundry_Template", + "FoundryRules_Workflow", + "Fusion_Document", + "Logic_Function", + "Machinery_ProcessGraph", + "Maps_Layer", + "Maps_Map", + "Marketplace_Installation", + "Marketplace_LocalStore", + "Marketplace_RemoteStore", + "Media_Set", + "Modeling_Model", + "Modeling_ModelVersion", + "Modeling_Objective", + "Monitoring_MonitoringView", + "Notepad_Document", + "Notepad_Template", + "ObjectExploration_Exploration", + "ObjectExploration_Layout", + "Quiver_Analysis", + "Slate_Application", + "SolutionDesigner_Diagram", + "ThirdPartyApplication_ThirdPartyApplication", + "Unknown", + "Vertex_Graph", + "Workshop_Module", +] +"""The type of a resource.""" diff --git a/foundry/v2/models/_schedule.py b/foundry/v2/models/_schedule.py index 9b32a7e02..1b0737c42 100644 --- a/foundry/v2/models/_schedule.py +++ b/foundry/v2/models/_schedule.py @@ -44,7 +44,7 @@ class Schedule(BaseModel): description: Optional[StrictStr] = None - version_rid: ScheduleVersionRid = Field(alias="versionRid") + current_version_rid: ScheduleVersionRid = Field(alias="currentVersionRid") """The RID of the current schedule version""" created_time: CreatedTime = Field(alias="createdTime") diff --git a/foundry/v2/models/_schedule_dict.py b/foundry/v2/models/_schedule_dict.py index 3725ebbfb..21d9ad88f 100644 --- a/foundry/v2/models/_schedule_dict.py +++ b/foundry/v2/models/_schedule_dict.py @@ -42,7 +42,7 @@ class ScheduleDict(TypedDict): description: NotRequired[StrictStr] - versionRid: ScheduleVersionRid + currentVersionRid: ScheduleVersionRid """The RID of the current schedule version""" createdTime: CreatedTime diff --git a/foundry/v2/models/_schedule_run.py b/foundry/v2/models/_schedule_run.py new file mode 100644 index 000000000..af76f1317 --- /dev/null +++ b/foundry/v2/models/_schedule_run.py @@ -0,0 +1,62 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.models._created_by import CreatedBy +from foundry.v2.models._created_time import CreatedTime +from foundry.v2.models._schedule_rid import ScheduleRid +from foundry.v2.models._schedule_run_dict import ScheduleRunDict +from foundry.v2.models._schedule_run_result import ScheduleRunResult +from foundry.v2.models._schedule_run_rid import ScheduleRunRid +from foundry.v2.models._schedule_version_rid import ScheduleVersionRid + + +class ScheduleRun(BaseModel): + """ScheduleRun""" + + rid: ScheduleRunRid + """The RID of a schedule run""" + + schedule_rid: ScheduleRid = Field(alias="scheduleRid") + + schedule_version_rid: ScheduleVersionRid = Field(alias="scheduleVersionRid") + + created_time: CreatedTime = Field(alias="createdTime") + """The time at which the schedule run was created.""" + + created_by: Optional[CreatedBy] = Field(alias="createdBy", default=None) + """ + The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to + empty. + """ + + result: Optional[ScheduleRunResult] = None + """ + The result of triggering the schedule. If empty, it means the service + is still working on triggering the schedule. + """ + + model_config = {"extra": "allow"} + + def to_dict(self) -> ScheduleRunDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ScheduleRunDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_schedule_run_dict.py b/foundry/v2/models/_schedule_run_dict.py new file mode 100644 index 000000000..a8b368263 --- /dev/null +++ b/foundry/v2/models/_schedule_run_dict.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.models._created_by import CreatedBy +from foundry.v2.models._created_time import CreatedTime +from foundry.v2.models._schedule_rid import ScheduleRid +from foundry.v2.models._schedule_run_result_dict import ScheduleRunResultDict +from foundry.v2.models._schedule_run_rid import ScheduleRunRid +from foundry.v2.models._schedule_version_rid import ScheduleVersionRid + + +class ScheduleRunDict(TypedDict): + """ScheduleRun""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: ScheduleRunRid + """The RID of a schedule run""" + + scheduleRid: ScheduleRid + + scheduleVersionRid: ScheduleVersionRid + + createdTime: CreatedTime + """The time at which the schedule run was created.""" + + createdBy: NotRequired[CreatedBy] + """ + The Foundry user who manually invoked this schedule run. Automatic trigger runs have this field set to + empty. + """ + + result: NotRequired[ScheduleRunResultDict] + """ + The result of triggering the schedule. If empty, it means the service + is still working on triggering the schedule. + """ diff --git a/foundry/v1/models/_language_model.py b/foundry/v2/models/_schedule_run_error.py similarity index 59% rename from foundry/v1/models/_language_model.py rename to foundry/v2/models/_schedule_run_error.py index ce24a7f77..99f3cc877 100644 --- a/foundry/v1/models/_language_model.py +++ b/foundry/v2/models/_schedule_run_error.py @@ -15,26 +15,28 @@ from __future__ import annotations -from typing import Optional +from typing import Literal from typing import cast from pydantic import BaseModel from pydantic import Field +from pydantic import StrictStr -from foundry.v1.models._language_model_api_name import LanguageModelApiName -from foundry.v1.models._language_model_dict import LanguageModelDict -from foundry.v1.models._language_model_source import LanguageModelSource +from foundry.v2.models._schedule_run_error_dict import ScheduleRunErrorDict +from foundry.v2.models._schedule_run_error_name import ScheduleRunErrorName -class LanguageModel(BaseModel): - """Represents a language model.""" +class ScheduleRunError(BaseModel): + """An error occurred attempting to run the schedule.""" - api_name: Optional[LanguageModelApiName] = Field(alias="apiName", default=None) + error_name: ScheduleRunErrorName = Field(alias="errorName") - source: Optional[LanguageModelSource] = None + description: StrictStr + + type: Literal["error"] model_config = {"extra": "allow"} - def to_dict(self) -> LanguageModelDict: + def to_dict(self) -> ScheduleRunErrorDict: """Return the dictionary representation of the model using the field aliases.""" - return cast(LanguageModelDict, self.model_dump(by_alias=True, exclude_unset=True)) + return cast(ScheduleRunErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_chat_message_dict.py b/foundry/v2/models/_schedule_run_error_dict.py similarity index 72% rename from foundry/v1/models/_chat_message_dict.py rename to foundry/v2/models/_schedule_run_error_dict.py index c3954a31b..1ef3b12b2 100644 --- a/foundry/v1/models/_chat_message_dict.py +++ b/foundry/v2/models/_schedule_run_error_dict.py @@ -15,18 +15,21 @@ from __future__ import annotations +from typing import Literal + from pydantic import StrictStr -from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v1.models._chat_message_role import ChatMessageRole +from foundry.v2.models._schedule_run_error_name import ScheduleRunErrorName -class ChatMessageDict(TypedDict): - """ChatMessage""" +class ScheduleRunErrorDict(TypedDict): + """An error occurred attempting to run the schedule.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - role: ChatMessageRole + errorName: ScheduleRunErrorName + + description: StrictStr - content: NotRequired[StrictStr] + type: Literal["error"] diff --git a/foundry/v2/models/_language_model_source.py b/foundry/v2/models/_schedule_run_error_name.py similarity index 73% rename from foundry/v2/models/_language_model_source.py rename to foundry/v2/models/_schedule_run_error_name.py index 6db27d115..be6f8a1a7 100644 --- a/foundry/v2/models/_language_model_source.py +++ b/foundry/v2/models/_schedule_run_error_name.py @@ -17,5 +17,13 @@ from typing import Literal -LanguageModelSource = Literal["global", "hosted"] -"""LanguageModelSource""" +ScheduleRunErrorName = Literal[ + "TargetResolutionFailure", + "CyclicDependency", + "IncompatibleTargets", + "PermissionDenied", + "JobSpecNotFound", + "ScheduleOwnerNotFound", + "Internal", +] +"""ScheduleRunErrorName""" diff --git a/foundry/v1/models/_chat_message.py b/foundry/v2/models/_schedule_run_ignored.py similarity index 65% rename from foundry/v1/models/_chat_message.py rename to foundry/v2/models/_schedule_run_ignored.py index f6e92cbe0..83329b347 100644 --- a/foundry/v1/models/_chat_message.py +++ b/foundry/v2/models/_schedule_run_ignored.py @@ -15,25 +15,21 @@ from __future__ import annotations -from typing import Optional +from typing import Literal from typing import cast from pydantic import BaseModel -from pydantic import StrictStr -from foundry.v1.models._chat_message_dict import ChatMessageDict -from foundry.v1.models._chat_message_role import ChatMessageRole +from foundry.v2.models._schedule_run_ignored_dict import ScheduleRunIgnoredDict -class ChatMessage(BaseModel): - """ChatMessage""" +class ScheduleRunIgnored(BaseModel): + """The schedule is not running as all targets are up-to-date.""" - role: ChatMessageRole - - content: Optional[StrictStr] = None + type: Literal["ignored"] model_config = {"extra": "allow"} - def to_dict(self) -> ChatMessageDict: + def to_dict(self) -> ScheduleRunIgnoredDict: """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatMessageDict, self.model_dump(by_alias=True, exclude_unset=True)) + return cast(ScheduleRunIgnoredDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_language_models_response_dict.py b/foundry/v2/models/_schedule_run_ignored_dict.py similarity index 74% rename from foundry/v2/models/_list_language_models_response_dict.py rename to foundry/v2/models/_schedule_run_ignored_dict.py index 039357e95..6a45f5884 100644 --- a/foundry/v2/models/_list_language_models_response_dict.py +++ b/foundry/v2/models/_schedule_run_ignored_dict.py @@ -15,17 +15,14 @@ from __future__ import annotations -from typing import List +from typing import Literal from typing_extensions import TypedDict -from foundry.v2.models._language_model_dict import LanguageModelDict - -class ListLanguageModelsResponseDict(TypedDict): - """ListLanguageModelsResponse""" +class ScheduleRunIgnoredDict(TypedDict): + """The schedule is not running as all targets are up-to-date.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - data: List[LanguageModelDict] - """The list of language models.""" + type: Literal["ignored"] diff --git a/foundry/v2/models/_language_model_api_name.py b/foundry/v2/models/_schedule_run_result.py similarity index 52% rename from foundry/v2/models/_language_model_api_name.py rename to foundry/v2/models/_schedule_run_result.py index b89af15bd..ed0f311e7 100644 --- a/foundry/v2/models/_language_model_api_name.py +++ b/foundry/v2/models/_schedule_run_result.py @@ -15,10 +15,19 @@ from __future__ import annotations -from pydantic import StrictStr +from typing import Annotated +from typing import Union -LanguageModelApiName = StrictStr +from pydantic import Field + +from foundry.v2.models._schedule_run_error import ScheduleRunError +from foundry.v2.models._schedule_run_ignored import ScheduleRunIgnored +from foundry.v2.models._schedule_run_submitted import ScheduleRunSubmitted + +ScheduleRunResult = Annotated[ + Union[ScheduleRunSubmitted, ScheduleRunIgnored, ScheduleRunError], Field(discriminator="type") +] """ -The name of the language model in the API. To find the API name for your model, use the `List language models` -endpoint. +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. """ diff --git a/foundry/v1/models/_chat_completion_response_dict.py b/foundry/v2/models/_schedule_run_result_dict.py similarity index 50% rename from foundry/v1/models/_chat_completion_response_dict.py rename to foundry/v2/models/_schedule_run_result_dict.py index 4051e94af..7f989cf7a 100644 --- a/foundry/v1/models/_chat_completion_response_dict.py +++ b/foundry/v2/models/_schedule_run_result_dict.py @@ -15,16 +15,20 @@ from __future__ import annotations -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._chat_completion_choice_dict import ChatCompletionChoiceDict - - -class ChatCompletionResponseDict(TypedDict): - """Contains `n` different completion choices as specified in the request parameter.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - choices: List[ChatCompletionChoiceDict] +from typing import Annotated +from typing import Union + +from pydantic import Field + +from foundry.v2.models._schedule_run_error_dict import ScheduleRunErrorDict +from foundry.v2.models._schedule_run_ignored_dict import ScheduleRunIgnoredDict +from foundry.v2.models._schedule_run_submitted_dict import ScheduleRunSubmittedDict + +ScheduleRunResultDict = Annotated[ + Union[ScheduleRunSubmittedDict, ScheduleRunIgnoredDict, ScheduleRunErrorDict], + Field(discriminator="type"), +] +""" +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. +""" diff --git a/foundry/v2/models/_parameter_value.py b/foundry/v2/models/_schedule_run_rid.py similarity index 87% rename from foundry/v2/models/_parameter_value.py rename to foundry/v2/models/_schedule_run_rid.py index 6fe850acf..d87abdb2f 100644 --- a/foundry/v2/models/_parameter_value.py +++ b/foundry/v2/models/_schedule_run_rid.py @@ -15,7 +15,7 @@ from __future__ import annotations -from typing import Any +from foundry._core.utils import RID -ParameterValue = Any -"""ParameterValue""" +ScheduleRunRid = RID +"""The RID of a schedule run""" diff --git a/foundry/v2/models/_schedule_run_submitted.py b/foundry/v2/models/_schedule_run_submitted.py new file mode 100644 index 000000000..15dee87cc --- /dev/null +++ b/foundry/v2/models/_schedule_run_submitted.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.models._build_rid import BuildRid +from foundry.v2.models._schedule_run_submitted_dict import ScheduleRunSubmittedDict + + +class ScheduleRunSubmitted(BaseModel): + """The schedule has been successfully triggered.""" + + build_rid: BuildRid = Field(alias="buildRid") + + type: Literal["submitted"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ScheduleRunSubmittedDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ScheduleRunSubmittedDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_language_models_response_dict.py b/foundry/v2/models/_schedule_run_submitted_dict.py similarity index 74% rename from foundry/v1/models/_list_language_models_response_dict.py rename to foundry/v2/models/_schedule_run_submitted_dict.py index 3cfc5d3af..64ca2fad6 100644 --- a/foundry/v1/models/_list_language_models_response_dict.py +++ b/foundry/v2/models/_schedule_run_submitted_dict.py @@ -15,17 +15,18 @@ from __future__ import annotations -from typing import List +from typing import Literal from typing_extensions import TypedDict -from foundry.v1.models._language_model_dict import LanguageModelDict +from foundry.v2.models._build_rid import BuildRid -class ListLanguageModelsResponseDict(TypedDict): - """ListLanguageModelsResponse""" +class ScheduleRunSubmittedDict(TypedDict): + """The schedule has been successfully triggered.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - data: List[LanguageModelDict] - """The list of language models.""" + buildRid: BuildRid + + type: Literal["submitted"] diff --git a/foundry/v2/models/_search_objects_for_interface_request.py b/foundry/v2/models/_search_objects_for_interface_request.py index 12ea765d0..c6abeedad 100644 --- a/foundry/v2/models/_search_objects_for_interface_request.py +++ b/foundry/v2/models/_search_objects_for_interface_request.py @@ -52,9 +52,9 @@ class SearchObjectsForInterfaceRequest(BaseModel): of properties specified in the value. """ - augmented_shared_property_types: Dict[ - InterfaceTypeApiName, List[SharedPropertyTypeApiName] - ] = Field(alias="augmentedSharedPropertyTypes") + augmented_shared_property_types: Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] = ( + Field(alias="augmentedSharedPropertyTypes") + ) """ A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object diff --git a/foundry/v2/models/_chat_message.py b/foundry/v2/models/_space.py similarity index 65% rename from foundry/v2/models/_chat_message.py rename to foundry/v2/models/_space.py index 496d21ffb..c3c3edbfd 100644 --- a/foundry/v2/models/_chat_message.py +++ b/foundry/v2/models/_space.py @@ -15,25 +15,21 @@ from __future__ import annotations -from typing import Optional from typing import cast from pydantic import BaseModel -from pydantic import StrictStr -from foundry.v2.models._chat_message_dict import ChatMessageDict -from foundry.v2.models._chat_message_role import ChatMessageRole +from foundry.v2.models._space_dict import SpaceDict +from foundry.v2.models._space_rid import SpaceRid -class ChatMessage(BaseModel): - """ChatMessage""" +class Space(BaseModel): + """Space""" - role: ChatMessageRole - - content: Optional[StrictStr] = None + rid: SpaceRid model_config = {"extra": "allow"} - def to_dict(self) -> ChatMessageDict: + def to_dict(self) -> SpaceDict: """Return the dictionary representation of the model using the field aliases.""" - return cast(ChatMessageDict, self.model_dump(by_alias=True, exclude_unset=True)) + return cast(SpaceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_language_model_api_name.py b/foundry/v2/models/_space_dict.py similarity index 74% rename from foundry/v1/models/_language_model_api_name.py rename to foundry/v2/models/_space_dict.py index b89af15bd..31f658faa 100644 --- a/foundry/v1/models/_language_model_api_name.py +++ b/foundry/v2/models/_space_dict.py @@ -15,10 +15,14 @@ from __future__ import annotations -from pydantic import StrictStr +from typing_extensions import TypedDict -LanguageModelApiName = StrictStr -""" -The name of the language model in the API. To find the API name for your model, use the `List language models` -endpoint. -""" +from foundry.v2.models._space_rid import SpaceRid + + +class SpaceDict(TypedDict): + """Space""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: SpaceRid diff --git a/foundry/v2/models/_chat_message_role.py b/foundry/v2/models/_space_rid.py similarity index 85% rename from foundry/v2/models/_chat_message_role.py rename to foundry/v2/models/_space_rid.py index 5e6fe52fe..02e7601cd 100644 --- a/foundry/v2/models/_chat_message_role.py +++ b/foundry/v2/models/_space_rid.py @@ -15,7 +15,7 @@ from __future__ import annotations -from typing import Literal +from foundry._core.utils import RID -ChatMessageRole = Literal["SYSTEM", "ASSISTANT", "USER"] -"""ChatMessageRole""" +SpaceRid = RID +"""The unique resource identifier (RID) of a Space.""" diff --git a/foundry/v2/models/_time_unit.py b/foundry/v2/models/_time_unit.py index 7407fe7fc..096775608 100644 --- a/foundry/v2/models/_time_unit.py +++ b/foundry/v2/models/_time_unit.py @@ -18,6 +18,6 @@ from typing import Literal TimeUnit = Literal[ - "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS", "QUARTERS" + "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS" ] """TimeUnit""" diff --git a/foundry/v1/models/_chat_message_role.py b/foundry/v2/models/_trashed_status.py similarity index 87% rename from foundry/v1/models/_chat_message_role.py rename to foundry/v2/models/_trashed_status.py index 5e6fe52fe..59a7001a7 100644 --- a/foundry/v1/models/_chat_message_role.py +++ b/foundry/v2/models/_trashed_status.py @@ -17,5 +17,5 @@ from typing import Literal -ChatMessageRole = Literal["SYSTEM", "ASSISTANT", "USER"] -"""ChatMessageRole""" +TrashedStatus = Literal["DIRECTLY_TRASHED", "ANCESTOR_TRASHED", "NOT_TRASHED"] +"""TrashedStatus""" diff --git a/openapi.yml b/openapi.yml index ef183d7ae..148c47f20 100644 --- a/openapi.yml +++ b/openapi.yml @@ -26,3140 +26,3583 @@ components: api:ontologies-read: Allows applications to read ontology data using Palantir APIs. api:ontologies-write: Allows applications to write ontology data using Palantir APIs. schemas: - RequestId: - type: string - format: uuid - description: Unique request id - x-namespace: Ontologies - x-safety: safe - SubscriptionId: - type: string - format: uuid - description: A unique identifier used to associate subscription requests with responses. - x-namespace: Ontologies - x-safety: safe - ObjectSetStreamSubscribeRequest: - type: object + ActionEditedPropertiesNotFound: + description: | + Actions attempted to edit properties that could not be found on the object type. + Please contact the Ontology administrator to resolve this issue. properties: - ontology: - $ref: "#/components/schemas/OntologyIdentifier" - objectSet: - $ref: "#/components/schemas/ObjectSet" - propertySet: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - referenceSet: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - required: - - objectSet + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectSetStreamSubscribeRequests: - type: object - 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" + ObjectAlreadyExists: + description: | + The object the user is attempting to create already exists. properties: - id: - description: "A randomly generated RequestId used to associate a ObjectSetStreamSubscribeRequest with a subsequent \nObjectSetSubscribeResponses. Each RequestId should be unique.\n" - $ref: "#/components/schemas/RequestId" - requests: - type: array - items: - $ref: "#/components/schemas/ObjectSetStreamSubscribeRequest" - required: - - id - x-namespace: Ontologies - StreamMessage: - type: object - discriminator: - propertyName: type - mapping: - subscribeResponses: "#/components/schemas/ObjectSetSubscribeResponses" - objectSetChanged: "#/components/schemas/ObjectSetUpdates" - refreshObjectSet: "#/components/schemas/RefreshObjectSet" - subscriptionClosed: "#/components/schemas/SubscriptionClosed" - oneOf: - - $ref: "#/components/schemas/ObjectSetSubscribeResponses" - - $ref: "#/components/schemas/ObjectSetUpdates" - - $ref: "#/components/schemas/RefreshObjectSet" - - $ref: "#/components/schemas/SubscriptionClosed" + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectSetSubscribeResponses: - type: object + LinkAlreadyExists: description: | - Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. + The link the user is attempting to create already exists. properties: - responses: - type: array - items: - $ref: "#/components/schemas/ObjectSetSubscribeResponse" - id: - $ref: "#/components/schemas/RequestId" - required: - - id - x-namespace: Ontologies - ObjectSetSubscribeResponse: - type: object - discriminator: - propertyName: type - mapping: - success: "#/components/schemas/SubscriptionSuccess" - error: "#/components/schemas/SubscriptionError" - qos: "#/components/schemas/QosError" - oneOf: - - $ref: "#/components/schemas/SubscriptionSuccess" - - $ref: "#/components/schemas/SubscriptionError" - - $ref: "#/components/schemas/QosError" + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - SubscriptionSuccess: - type: object - properties: - id: - $ref: "#/components/schemas/SubscriptionId" - required: - - id + FunctionExecutionFailed: + x-type: error x-namespace: Ontologies - SubscriptionError: - type: object properties: - errors: - type: array - items: - $ref: "#/components/schemas/Error" - x-namespace: Ontologies - QosError: - type: object + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + ParentAttachmentPermissionDenied: description: | - An error indicating that the subscribe request should be attempted on a different node. - x-namespace: Ontologies - ErrorName: - type: string - x-safety: safe - x-namespace: Ontologies - Arg: - type: object + The user does not have permission to parent attachments. properties: - name: + parameters: + type: object + errorCode: + enum: + - PERMISSION_DENIED type: string - x-safety: safe - value: + errorName: type: string - x-safety: unsafe - required: - - name - - value + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - Error: - type: object + EditObjectPermissionDenied: + description: | + The user does not have permission to edit this `ObjectType`. properties: - error: - $ref: "#/components/schemas/ErrorName" - args: - type: array - items: - $ref: "#/components/schemas/Arg" - required: - - error + parameters: + type: object + errorCode: + enum: + - PERMISSION_DENIED + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ReasonType: + ViewObjectPermissionDenied: description: | - Represents the reason a subscription was closed. - enum: - - USER_CLOSED - - CHANNEL_CLOSED - x-namespace: Ontologies - Reason: - type: object + The provided token does not have permission to view any data sources backing this object type. Ensure the object + type has backing data sources configured and visible. properties: - reason: - $ref: "#/components/schemas/ReasonType" - required: - - reason - x-namespace: Ontologies - SubscriptionClosureCause: - type: object - discriminator: - propertyName: type - mapping: - error: "#/components/schemas/Error" - reason: "#/components/schemas/Reason" - oneOf: - - $ref: "#/components/schemas/Error" - - $ref: "#/components/schemas/Reason" + parameters: + type: object + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectType + errorCode: + enum: + - PERMISSION_DENIED + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - RefreshObjectSet: - type: object + ObjectChanged: description: | - The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. + An object used by this `Action` was changed by someone else while the `Action` was running. properties: - id: - $ref: "#/components/schemas/SubscriptionId" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - id - - objectType + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - SubscriptionClosed: - type: object + ActionParameterObjectTypeNotFound: description: | - The subscription has been closed due to an irrecoverable error during its lifecycle. + The parameter references an object type that could not be found, or the client token does not have access to it. properties: - id: - $ref: "#/components/schemas/SubscriptionId" - cause: - $ref: "#/components/schemas/SubscriptionClosureCause" - required: - - id - - cause + parameters: + type: object + properties: + parameterId: + $ref: "#/components/schemas/ParameterId" + required: + - parameterId + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectSetUpdates: - type: object + ActionParameterObjectNotFound: + description: | + The parameter object reference or parameter default value is not found, or the client token does not have access to it. properties: - id: - $ref: "#/components/schemas/SubscriptionId" - updates: - type: array - items: - $ref: "#/components/schemas/ObjectSetUpdate" - required: - - id - x-namespace: Ontologies - ObjectSetUpdate: - type: object - discriminator: - propertyName: type - mapping: - object: "#/components/schemas/ObjectUpdate" - reference: "#/components/schemas/ReferenceUpdate" - oneOf: - - $ref: "#/components/schemas/ObjectUpdate" - - $ref: "#/components/schemas/ReferenceUpdate" - x-namespace: Ontologies - ObjectState: - 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" - enum: - - ADDED_OR_UPDATED - - REMOVED + parameters: + type: object + properties: + parameterId: + $ref: "#/components/schemas/ParameterId" + required: + - parameterId + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectUpdate: - type: object + ActionNotFound: + description: "The action is not found, or the user does not have access to it." properties: - object: - $ref: "#/components/schemas/OntologyObjectV2" - state: - $ref: "#/components/schemas/ObjectState" - required: - - object - - state + parameters: + properties: + actionRid: + $ref: "#/components/schemas/ActionRid" + required: + - actionRid + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectPrimaryKey: - type: object - additionalProperties: - $ref: "#/components/schemas/PropertyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" + ActionTypeNotFound: + description: "The action type is not found, or the user does not have access to it." + properties: + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + rid: + $ref: "#/components/schemas/ActionTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ReferenceUpdate: - type: object + ActionValidationFailed: description: | - The updated data value associated with an object instance's external reference. The object instance - is uniquely identified by an object type and a primary key. Note that the value of the property - field returns a dereferenced value rather than the reference itself. + The validation failed for the given action parameters. Please use the `validateAction` endpoint for more + details. properties: - apiName: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - $ref: "#/components/schemas/ObjectPrimaryKey" - description: The ObjectPrimaryKey of the object instance supplying the reference property. - propertyApiName: - $ref: "#/components/schemas/PropertyApiName" - description: The PropertyApiName on the object type that corresponds to the reference property - value: - $ref: "#/components/schemas/ReferenceValue" - required: - - apiName - - primaryKey - - propertyApiName - - value + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + required: + - actionType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ReferenceValue: - type: object - description: Resolved data values pointed to by a reference. - discriminator: - propertyName: type - mapping: - geotimeSeriesValue: "#/components/schemas/GeotimeSeriesValue" - oneOf: - - $ref: "#/components/schemas/GeotimeSeriesValue" + ApplyActionFailed: + properties: + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - GeotimeSeriesValue: - type: object - description: The underlying data values pointed to by a GeotimeSeriesReference. + AttachmentNotFound: + 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" properties: - position: - $ref: "#/components/schemas/Position" - timestamp: + parameters: + type: object + properties: + attachmentRid: + $ref: "#/components/schemas/AttachmentRid" + errorCode: + enum: + - NOT_FOUND type: string - format: date-time - x-safety: unsafe - required: - - position - - timestamp + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - GeoJsonObject: + AttachmentSizeExceededLimit: description: | - GeoJSon object - - The coordinate reference system for all GeoJSON coordinates is a - geographic coordinate reference system, using the World Geodetic System - 1984 (WGS 84) datum, with longitude and latitude units of decimal - degrees. - This is equivalent to the coordinate reference system identified by the - Open Geospatial Consortium (OGC) URN - An OPTIONAL third-position element SHALL be the height in meters above - or below the WGS 84 reference ellipsoid. - In the absence of elevation values, applications sensitive to height or - depth SHOULD interpret positions as being at local ground or sea level. - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3 - discriminator: - propertyName: type - mapping: - Feature: "#/components/schemas/Feature" - FeatureCollection: "#/components/schemas/FeatureCollection" - Point: "#/components/schemas/GeoPoint" - MultiPoint: "#/components/schemas/MultiPoint" - LineString: "#/components/schemas/LineString" - MultiLineString: "#/components/schemas/MultiLineString" - Polygon: "#/components/schemas/Polygon" - MultiPolygon: "#/components/schemas/MultiPolygon" - GeometryCollection: "#/components/schemas/GeometryCollection" - oneOf: - - $ref: "#/components/schemas/Feature" - - $ref: "#/components/schemas/FeatureCollection" - - $ref: "#/components/schemas/GeoPoint" - - $ref: "#/components/schemas/MultiPoint" - - $ref: "#/components/schemas/LineString" - - $ref: "#/components/schemas/MultiLineString" - - $ref: "#/components/schemas/Polygon" - - $ref: "#/components/schemas/MultiPolygon" - - $ref: "#/components/schemas/GeometryCollection" - type: object + The file is too large to be uploaded as an attachment. + The maximum attachment size is 200MB. properties: - type: - type: string + parameters: + type: object + properties: + fileSizeBytes: + type: string + x-safety: unsafe + fileLimitBytes: + type: string + x-safety: safe + required: + - fileSizeBytes + - fileLimitBytes + errorCode: enum: - - Feature - - FeatureCollection - - Point - - MultiPoint - - LineString - - MultiLineString - - Polygon - - MultiPolygon - - GeometryCollection - Geometry: - nullable: true - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1 - description: Abstract type for all GeoJSon object except Feature and FeatureCollection - discriminator: - propertyName: type - mapping: - Point: "#/components/schemas/GeoPoint" - MultiPoint: "#/components/schemas/MultiPoint" - LineString: "#/components/schemas/LineString" - MultiLineString: "#/components/schemas/MultiLineString" - Polygon: "#/components/schemas/Polygon" - MultiPolygon: "#/components/schemas/MultiPolygon" - GeometryCollection: "#/components/schemas/GeometryCollection" - oneOf: - - $ref: "#/components/schemas/GeoPoint" - - $ref: "#/components/schemas/MultiPoint" - - $ref: "#/components/schemas/LineString" - - $ref: "#/components/schemas/MultiLineString" - - $ref: "#/components/schemas/Polygon" - - $ref: "#/components/schemas/MultiPolygon" - - $ref: "#/components/schemas/GeometryCollection" - FeaturePropertyKey: - type: string - x-safety: unsafe - FeatureCollectionTypes: - discriminator: - propertyName: type - mapping: - Feature: "#/components/schemas/Feature" - oneOf: - - $ref: "#/components/schemas/Feature" - Feature: - type: object - description: GeoJSon 'Feature' object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.2 + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + DuplicateOrderBy: + description: The requested sort order includes duplicate properties. properties: - geometry: - $ref: "#/components/schemas/Geometry" - properties: - description: | - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - additionalProperties: - x-safety: unsafe - x-mapKey: - $ref: "#/components/schemas/FeaturePropertyKey" - id: - description: | - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - x-safety: unsafe - bbox: - $ref: "#/components/schemas/BBox" - FeatureCollection: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.3 - description: GeoJSon 'FeatureCollection' object - type: object + parameters: + properties: + properties: + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + FunctionInvalidInput: + x-type: error + x-namespace: Ontologies properties: - features: - type: array - items: - $ref: "#/components/schemas/FeatureCollectionTypes" - bbox: - $ref: "#/components/schemas/BBox" - GeoPoint: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 - type: object + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + FunctionExecutionTimedOut: + x-type: error + x-namespace: Ontologies properties: - coordinates: - $ref: "#/components/schemas/Position" - bbox: - $ref: "#/components/schemas/BBox" - required: - - coordinates - MultiPoint: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.3 - type: object + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - TIMEOUT + type: string + errorName: + type: string + errorInstanceId: + type: string + CompositePrimaryKeyNotSupported: + description: | + Primary keys consisting of multiple properties are not supported by this API. If you need support for this, + please reach out to Palantir Support. properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/Position" - bbox: - $ref: "#/components/schemas/BBox" - LineString: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + required: + - objectType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + InvalidContentLength: + description: "A `Content-Length` header is required for all uploads, but was missing or invalid." properties: - coordinates: - $ref: "#/components/schemas/LineStringCoordinates" - bbox: - $ref: "#/components/schemas/BBox" - MultiLineString: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 - type: object + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + InvalidContentType: + description: | + The `Content-Type` cannot be inferred from the request content and filename. + Please check your request content and filename to ensure they are compatible. properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/LineStringCoordinates" - bbox: - $ref: "#/components/schemas/BBox" - Polygon: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 - type: object - properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/LinearRing" - bbox: - $ref: "#/components/schemas/BBox" - MultiPolygon: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7 - type: object - properties: - coordinates: - type: array - items: - type: array - items: - $ref: "#/components/schemas/LinearRing" - bbox: - $ref: "#/components/schemas/BBox" - LineStringCoordinates: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.4 - description: | - GeoJSon fundamental geometry construct, array of two or more positions. - type: array - items: - $ref: "#/components/schemas/Position" - minItems: 2 - LinearRing: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.6 - description: | - A linear ring is a closed LineString with four or more positions. - - The first and last positions are equivalent, and they MUST contain - identical values; their representation SHOULD also be identical. - - A linear ring is the boundary of a surface or the boundary of a hole in - a surface. - - A linear ring MUST follow the right-hand rule with respect to the area - it bounds, i.e., exterior rings are counterclockwise, and holes are - clockwise. - type: array - items: - $ref: "#/components/schemas/Position" - minItems: 4 - GeometryCollection: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.8 - description: | - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - type: object - properties: - geometries: - type: array - items: - $ref: "#/components/schemas/Geometry" - minItems: 0 - bbox: - $ref: "#/components/schemas/BBox" - Position: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.1 - description: | - GeoJSon fundamental geometry construct. - - A position is an array of numbers. There MUST be two or more elements. - The first two elements are longitude and latitude, precisely in that order and using decimal numbers. - Altitude or elevation MAY be included as an optional third element. - - Implementations SHOULD NOT extend positions beyond three elements - because the semantics of extra elements are unspecified and ambiguous. - Historically, some implementations have used a fourth element to carry - a linear referencing measure (sometimes denoted as "M") or a numerical - timestamp, but in most situations a parser will not be able to properly - interpret these values. The interpretation and meaning of additional - elements is beyond the scope of this specification, and additional - elements MAY be ignored by parsers. - type: array - items: - $ref: "#/components/schemas/Coordinate" - minItems: 2 - maxItems: 3 - BBox: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-5 - description: | - A GeoJSON object MAY have a member named "bbox" to include - information on the coordinate range for its Geometries, Features, or - FeatureCollections. The value of the bbox member MUST be an array of - length 2*n where n is the number of dimensions represented in the - contained geometries, with all axes of the most southwesterly point - followed by all axes of the more northeasterly point. The axes order - of a bbox follows the axes order of geometries. - type: array - items: - $ref: "#/components/schemas/Coordinate" - Coordinate: - type: number - format: double - x-safety: unsafe - AggregateObjectsRequestV2: - type: object + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + FunctionEncounteredUserFacingError: + description: | + The authored function failed to execute because of a user induced error. The message argument + is meant to be displayed to the user. properties: - aggregation: - items: - $ref: "#/components/schemas/AggregationV2" - type: array - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - groupBy: - items: - $ref: "#/components/schemas/AggregationGroupByV2" - type: array - accuracy: - $ref: "#/components/schemas/AggregationAccuracyRequest" - AggregationV2: - description: Specifies an aggregation function. - type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - max: "#/components/schemas/MaxAggregationV2" - min: "#/components/schemas/MinAggregationV2" - avg: "#/components/schemas/AvgAggregationV2" - sum: "#/components/schemas/SumAggregationV2" - count: "#/components/schemas/CountAggregationV2" - approximateDistinct: "#/components/schemas/ApproximateDistinctAggregationV2" - approximatePercentile: "#/components/schemas/ApproximatePercentileAggregationV2" - oneOf: - - $ref: "#/components/schemas/MaxAggregationV2" - - $ref: "#/components/schemas/MinAggregationV2" - - $ref: "#/components/schemas/AvgAggregationV2" - - $ref: "#/components/schemas/SumAggregationV2" - - $ref: "#/components/schemas/CountAggregationV2" - - $ref: "#/components/schemas/ApproximateDistinctAggregationV2" - - $ref: "#/components/schemas/ApproximatePercentileAggregationV2" - MaxAggregationV2: - description: Computes the maximum value for the provided field. - type: object + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + message: + type: string + x-safety: unsafe + required: + - functionRid + - functionVersion + - message + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidGroupId: + description: The provided value for a group id must be a UUID. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - MinAggregationV2: - description: Computes the minimum value for the provided field. - type: object + parameters: + properties: + groupId: + type: string + x-safety: unsafe + required: + - groupId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidUserId: + description: The provided value for a user id must be a UUID. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - AvgAggregationV2: - description: Computes the average value for the provided field. - type: object + parameters: + properties: + userId: + type: string + x-safety: unsafe + required: + - userId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + AggregationGroupCountExceededLimit: + description: | + The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by + adjusting your query to reduce the number of groups created by your aggregation. For instance: + - If you are using multiple `groupBy` clauses, try reducing the number of clauses. + - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first + to reduce the number of groups. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - SumAggregationV2: - description: Computes the sum of values for the provided field. - type: object + parameters: + properties: + groupsCount: + type: integer + x-safety: safe + groupsLimit: + type: integer + x-safety: safe + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + AggregationMemoryExceededLimit: + description: | + The amount of memory used in the request exceeded the limit. The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by + adjusting your query to reduce the number of groups created by your aggregation. For instance: + - If you are using multiple `groupBy` clauses, try reducing the number of clauses. + - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first + to reduce the number of groups. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - CountAggregationV2: - description: Computes the total count of objects. - type: object + parameters: + properties: + memoryUsedBytes: + type: string + x-safety: safe + memoryLimitBytes: + type: string + x-safety: safe + type: object + required: + - memoryUsedBytes + - memoryLimitBytes + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidParameterValue: + description: | + The value of the given parameter is invalid. See the documentation of `DataValue` for details on + how parameters are represented. properties: - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - ApproximateDistinctAggregationV2: - description: Computes an approximate number of distinct values for the provided field. - type: object + parameters: + properties: + parameterBaseType: + $ref: "#/components/schemas/ValueType" + parameterDataType: + $ref: "#/components/schemas/OntologyDataType" + parameterId: + $ref: "#/components/schemas/ParameterId" + parameterValue: + $ref: "#/components/schemas/DataValue" + required: + - parameterId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidQueryParameterValue: + description: | + The value of the given parameter is invalid. See the documentation of `DataValue` for details on + how parameters are represented. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - ApproximatePercentileAggregationV2: - description: Computes the approximate percentile value for the provided field. - type: object + parameters: + properties: + parameterDataType: + $ref: "#/components/schemas/QueryDataType" + parameterId: + $ref: "#/components/schemas/ParameterId" + parameterValue: + $ref: "#/components/schemas/DataValue" + required: + - parameterId + - parameterDataType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidFields: + description: | + The value of the given field does not match the expected pattern. For example, an Ontology object property `id` + should be written `properties.id`. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - approximatePercentile: - type: number - format: double - x-safety: safe - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - - approximatePercentile - OrderByDirection: - x-namespace: Ontologies - enum: - - ASC - - DESC - AggregationGroupByV2: - description: Specifies a grouping for aggregation results. - type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - fixedWidth: "#/components/schemas/AggregationFixedWidthGroupingV2" - ranges: "#/components/schemas/AggregationRangesGroupingV2" - exact: "#/components/schemas/AggregationExactGroupingV2" - duration: "#/components/schemas/AggregationDurationGroupingV2" - oneOf: - - $ref: "#/components/schemas/AggregationFixedWidthGroupingV2" - - $ref: "#/components/schemas/AggregationRangesGroupingV2" - - $ref: "#/components/schemas/AggregationExactGroupingV2" - - $ref: "#/components/schemas/AggregationDurationGroupingV2" - AggregationAccuracyRequest: - x-namespace: Ontologies - enum: - - REQUIRE_ACCURATE - - ALLOW_APPROXIMATE - AggregationAccuracy: + parameters: + properties: + properties: + items: + type: string + x-safety: unsafe + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - enum: - - ACCURATE - - APPROXIMATE - AggregateObjectsResponseV2: + InvalidPropertyFilterValue: + description: | + The value of the given property filter is invalid. For instance, 2 is an invalid value for + `isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type. properties: - excludedItems: - type: integer - x-safety: unsafe - accuracy: - $ref: "#/components/schemas/AggregationAccuracy" - data: - items: - $ref: "#/components/schemas/AggregateObjectsResponseItemV2" - type: array - type: object - required: - - accuracy - x-namespace: Ontologies - AggregateObjectsResponseItemV2: - type: object + parameters: + properties: + expectedType: + $ref: "#/components/schemas/ValueType" + propertyFilter: + $ref: "#/components/schemas/PropertyFilter" + propertyFilterValue: + $ref: "#/components/schemas/FilterValue" + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - expectedType + - property + - propertyFilter + - propertyFilterValue + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidPropertyFiltersCombination: + description: The provided filters cannot be used together. properties: - group: - additionalProperties: - $ref: "#/components/schemas/AggregationGroupValueV2" - x-mapKey: - $ref: "#/components/schemas/AggregationGroupKeyV2" - metrics: - items: - $ref: "#/components/schemas/AggregationMetricResultV2" - type: array - AggregationMetricResultV2: - type: object + parameters: + properties: + propertyFilters: + items: + $ref: "#/components/schemas/PropertyFilter" + type: array + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidPropertyValue: + description: | + The value of the given property is invalid. See the documentation of `PropertyValue` for details on + how properties are represented. properties: - name: + parameters: + properties: + propertyBaseType: + $ref: "#/components/schemas/ValueType" + property: + $ref: "#/components/schemas/PropertyApiName" + propertyValue: + $ref: "#/components/schemas/PropertyValue" + required: + - property + - propertyBaseType + - propertyValue + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - value: - description: | - The value of the metric. This will be a double in the case of - a numeric metric, or a date string in the case of a date metric. - x-safety: unsafe - required: - - name - AggregationGroupKeyV2: - type: string - x-namespace: Ontologies - x-safety: unsafe - AggregationGroupValueV2: - x-safety: unsafe - x-namespace: Ontologies - AggregationExactGroupingV2: - description: Divides objects into groups according to an exact value. - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidPropertyType: + description: | + The given property type is not of the expected type. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - maxGroupCount: - type: integer - x-safety: safe - required: - - field - AggregationFixedWidthGroupingV2: - description: Divides objects into groups with the specified width. - type: object + parameters: + properties: + propertyBaseType: + $ref: "#/components/schemas/ValueType" + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + - propertyBaseType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidSortOrder: + description: | + The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort + order can also be omitted, and defaults to 'asc'. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - fixedWidth: - type: integer - x-safety: safe - required: - - field - - fixedWidth - AggregationRangeV2: - description: Specifies a range from an inclusive start value to an exclusive end value. - type: object + parameters: + properties: + invalidSortOrder: + type: string + x-safety: unsafe + required: + - invalidSortOrder + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidSortType: + description: The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'. properties: - startValue: - description: Inclusive start. - x-safety: unsafe - endValue: - description: Exclusive end. - x-safety: unsafe - required: - - startValue - - endValue - AggregationRangesGroupingV2: - description: Divides objects into groups according to specified ranges. - type: object + parameters: + properties: + invalidSortType: + type: string + x-safety: safe + required: + - invalidSortType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + LinkTypeNotFound: + description: "The link type is not found, or the user does not have access to it." properties: - field: - $ref: "#/components/schemas/PropertyApiName" - ranges: - items: - $ref: "#/components/schemas/AggregationRangeV2" - type: array - required: - - field - AggregationDurationGroupingV2: - description: | - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + linkType: + $ref: "#/components/schemas/LinkTypeApiName" + required: + - linkType + - objectType + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + LinkedObjectNotFound: + description: "The linked object with the given primary key is not found, or the user does not have access to it." properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: integer - x-safety: unsafe - unit: - $ref: "#/components/schemas/TimeUnit" - required: - - field - - value - - unit - AggregationObjectTypeGrouping: - 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" - type: object - x-namespace: Ontologies - properties: {} - ArtifactRepositoryRid: - type: string - format: rid - x-safety: safe - SdkPackageName: - type: string - x-safety: unsafe - ObjectSetRid: - type: string - format: rid - x-safety: safe - CreateTemporaryObjectSetRequestV2: - type: object + parameters: + properties: + linkType: + $ref: "#/components/schemas/LinkTypeApiName" + linkedObjectType: + $ref: "#/components/schemas/ObjectTypeApiName" + linkedObjectPrimaryKey: + additionalProperties: + $ref: "#/components/schemas/PrimaryKeyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + required: + - linkType + - linkedObjectType + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + MalformedPropertyFilters: + description: | + At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`. properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - required: - - objectSet - CreateTemporaryObjectSetResponseV2: - type: object + parameters: + properties: + malformedPropertyFilter: + type: string + x-safety: unsafe + required: + - malformedPropertyFilter + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + MissingParameter: + description: | + Required parameters are missing. Please look at the `parameters` field to see which required parameters are + missing from the request. properties: - objectSetRid: - $ref: "#/components/schemas/ObjectSetRid" - required: - - objectSetRid - AggregateObjectSetRequestV2: - type: object + parameters: + properties: + parameters: + items: + $ref: "#/components/schemas/ParameterId" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + MultiplePropertyValuesNotSupported: + description: | + One of the requested property filters does not support multiple values. Please include only a single value for + it. properties: - aggregation: - items: - $ref: "#/components/schemas/AggregationV2" - type: array - objectSet: - $ref: "#/components/schemas/ObjectSet" - groupBy: - items: - $ref: "#/components/schemas/AggregationGroupByV2" - type: array - accuracy: - $ref: "#/components/schemas/AggregationAccuracyRequest" - required: - - objectSet - ActionTypeV2: - type: object + parameters: + properties: + propertyFilter: + $ref: "#/components/schemas/PropertyFilter" + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + - propertyFilter + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - description: Represents an action type in the Ontology. + ObjectNotFound: + description: "The requested object is not found, or the client token does not have access to it." properties: - apiName: - $ref: "#/components/schemas/ActionTypeApiName" - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" parameters: - additionalProperties: - $ref: "#/components/schemas/ActionParameterV2" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - rid: - $ref: "#/components/schemas/ActionTypeRid" - operations: - type: array - items: - $ref: "#/components/schemas/LogicRule" - required: - - apiName - - status - - rid - ActionParameterV2: - description: Details about a parameter of an action. - properties: - description: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + additionalProperties: + $ref: "#/components/schemas/PrimaryKeyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + type: object + errorCode: + enum: + - NOT_FOUND type: string - x-safety: unsafe - dataType: - $ref: "#/components/schemas/ActionParameterType" - required: - type: boolean - x-safety: safe - required: - - dataType - - required - type: object - x-namespace: Ontologies - BatchApplyActionRequestItem: + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - type: object + ObjectTypeNotFound: + description: "The requested object type is not found, or the client token does not have access to it." properties: parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - BatchApplyActionRequestV2: - properties: - options: - $ref: "#/components/schemas/BatchApplyActionRequestOptions" - requests: - type: array - items: - $ref: "#/components/schemas/BatchApplyActionRequestItem" - type: object - x-namespace: Ontologies - BatchApplyActionResponseV2: - type: object + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + objectTypeRid: + $ref: "#/components/schemas/ObjectTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + UnsupportedObjectSet: + description: The requested object set is not supported. properties: - edits: - $ref: "#/components/schemas/ActionResults" - ListActionTypesResponseV2: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/ActionTypeV2" - type: array - type: object + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ListInterfaceTypesResponse: + ObjectsExceededLimit: + description: | + There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this + API for a given request. properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/InterfaceType" - type: array - type: object + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - SearchObjectsForInterfaceRequest: - type: object + OntologyEditsExceededLimit: + description: | + The number of edits to the Ontology exceeded the allowed limit. + This may happen because of the request or because the Action is modifying too many objects. + Please change the size of your request or contact the Ontology administrator. + properties: + parameters: + properties: + editsCount: + type: integer + x-safety: unsafe + editsLimit: + type: integer + x-safety: unsafe + required: + - editsCount + - editsLimit + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + OntologyNotFound: + description: "The requested Ontology is not found, or the client token does not have access to it." properties: - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - orderBy: - $ref: "#/components/schemas/SearchOrderByV2" - augmentedProperties: - 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" - additionalProperties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - x-mapKey: - $ref: "#/components/schemas/ObjectTypeApiName" - augmentedSharedPropertyTypes: - 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" - additionalProperties: - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: array - x-mapKey: - $ref: "#/components/schemas/InterfaceTypeApiName" - selectedSharedPropertyTypes: - 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" - type: array - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - selectedObjectTypes: - 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" - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - otherInterfaceTypes: - 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" - type: array - items: - $ref: "#/components/schemas/InterfaceTypeApiName" - pageSize: - $ref: "#/components/schemas/PageSize" - pageToken: - $ref: "#/components/schemas/PageToken" - ListQueryTypesResponseV2: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/QueryTypeV2" - type: array - type: object - x-namespace: Ontologies - ListAttachmentsResponseV2: - type: object + parameters: + properties: + ontologyRid: + $ref: "#/components/schemas/OntologyRid" + apiName: + $ref: "#/components/schemas/OntologyApiName" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + OntologySyncing: + description: | + The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a + few seconds and try again. properties: - data: - items: - $ref: "#/components/schemas/AttachmentV2" - type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - AttachmentMetadataResponse: - description: The attachment metadata response - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectType + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - single: "#/components/schemas/AttachmentV2" - multiple: "#/components/schemas/ListAttachmentsResponseV2" - oneOf: - - $ref: "#/components/schemas/AttachmentV2" - - $ref: "#/components/schemas/ListAttachmentsResponseV2" - AbsoluteTimeRange: - description: ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - type: object + OntologySyncingObjectTypes: + description: | + One or more requested object types have been changed in the **Ontology Manager** and changes are currently being + applied. Wait a few seconds and try again. + properties: + parameters: + properties: + objectTypes: + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ObjectTypeNotSynced: + description: | + The requested object type is not synced into the ontology. Please reach out to your Ontology + Administrator to re-index the object type in Ontology Management Application. properties: - startTime: + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectType + type: object + errorCode: + enum: + - CONFLICT type: string - format: date-time - x-safety: unsafe - endTime: + errorName: type: string - format: date-time - x-safety: unsafe - ActionMode: + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - enum: - - ASYNC - - RUN - - VALIDATE - AsyncApplyActionResponseV2: - type: object + ObjectTypesNotSynced: + description: | + One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology + Administrator to re-index the object type(s) in Ontology Management Application. + properties: + parameters: + properties: + objectTypes: + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParameterTypeNotSupported: + description: | + The type of the requested parameter is not currently supported by this API. If you need support for this, + please reach out to Palantir Support. properties: - operationId: + parameters: + properties: + parameterId: + $ref: "#/components/schemas/ParameterId" + parameterBaseType: + $ref: "#/components/schemas/ValueType" + required: + - parameterBaseType + - parameterId + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - format: rid - x-safety: safe - required: - - operationId - SyncApplyActionResponseV2: - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParametersNotFound: + description: | + The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field + to see which ones are available. properties: - validation: - $ref: "#/components/schemas/ValidateActionResponseV2" - edits: - $ref: "#/components/schemas/ActionResults" - ActionResults: - discriminator: - propertyName: type - mapping: - edits: "#/components/schemas/ObjectEdits" - largeScaleEdits: "#/components/schemas/ObjectTypeEdits" - oneOf: - - $ref: "#/components/schemas/ObjectEdits" - - $ref: "#/components/schemas/ObjectTypeEdits" - ObjectTypeEdits: - type: object + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + unknownParameterIds: + items: + $ref: "#/components/schemas/ParameterId" + type: array + configuredParameterIds: + items: + $ref: "#/components/schemas/ParameterId" + type: array + required: + - actionType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + PropertiesNotFound: + description: The requested properties are not found on the object type. properties: - editedObjectTypes: - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - ObjectEdits: - type: object - properties: - edits: - type: array - items: - $ref: "#/components/schemas/ObjectEdit" - addedObjectCount: - type: integer - x-safety: safe - modifiedObjectsCount: - type: integer - x-safety: safe - deletedObjectsCount: - type: integer - x-safety: safe - addedLinksCount: - type: integer - x-safety: safe - deletedLinksCount: - type: integer - x-safety: safe - required: - - addedObjectCount - - modifiedObjectsCount - - deletedObjectsCount - - addedLinksCount - - deletedLinksCount - ObjectEdit: - discriminator: - propertyName: type - mapping: - addObject: "#/components/schemas/AddObject" - modifyObject: "#/components/schemas/ModifyObject" - addLink: "#/components/schemas/AddLink" - oneOf: - - $ref: "#/components/schemas/AddObject" - - $ref: "#/components/schemas/ModifyObject" - - $ref: "#/components/schemas/AddLink" - AddObject: - type: object - properties: - primaryKey: - $ref: "#/components/schemas/PropertyValue" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - primaryKey - - objectType - ModifyObject: - type: object - properties: - primaryKey: - $ref: "#/components/schemas/PropertyValue" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - primaryKey - - objectType - AddLink: - type: object - properties: - linkTypeApiNameAtoB: - $ref: "#/components/schemas/LinkTypeApiName" - linkTypeApiNameBtoA: - $ref: "#/components/schemas/LinkTypeApiName" - aSideObject: - $ref: "#/components/schemas/LinkSideObject" - bSideObject: - $ref: "#/components/schemas/LinkSideObject" - required: - - linkTypeApiNameAtoB - - linkTypeApiNameBtoA - - aSideObject - - bSideObject - LinkSideObject: - type: object - properties: - primaryKey: - $ref: "#/components/schemas/PropertyValue" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - primaryKey - - objectType - LinkTypeRid: - type: string - format: rid - x-safety: safe - x-namespace: Ontologies - LinkTypeSideV2: - type: object - x-namespace: Ontologies - properties: - apiName: - $ref: "#/components/schemas/LinkTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - cardinality: - $ref: "#/components/schemas/LinkTypeSideCardinality" - foreignKeyPropertyApiName: - $ref: "#/components/schemas/PropertyApiName" - linkTypeRid: - $ref: "#/components/schemas/LinkTypeRid" - required: - - apiName - - displayName - - status - - objectTypeApiName - - cardinality - - linkTypeRid - ListOutgoingLinkTypesResponseV2: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of link type sides in the current page. - items: - $ref: "#/components/schemas/LinkTypeSideV2" - type: array - type: object - x-namespace: Ontologies - ApplyActionRequestV2: + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + properties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + required: + - objectType + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - type: object + PropertiesNotSortable: + description: | + Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and + *Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay + between the time a property is set to *Searchable* and *Sortable* and when it can be used. properties: - options: - $ref: "#/components/schemas/ApplyActionRequestOptions" parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - ApplyActionMode: - x-namespace: Ontologies - enum: - - VALIDATE_ONLY - - VALIDATE_AND_EXECUTE - ApplyActionRequestOptions: - type: object + properties: + properties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParameterObjectNotFound: + description: | + The parameter object reference or parameter default value is not found, or the client token does not have access to it. properties: - mode: - $ref: "#/components/schemas/ApplyActionMode" - returnEdits: - $ref: "#/components/schemas/ReturnEditsMode" - BatchApplyActionRequestOptions: - type: object + parameters: + type: object + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + additionalProperties: + $ref: "#/components/schemas/PrimaryKeyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + required: + - objectType + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParameterObjectSetRidNotFound: + description: | + The parameter object set RID is not found, or the client token does not have access to it. properties: - returnEdits: - $ref: "#/components/schemas/ReturnEditsMode" - ReturnEditsMode: + parameters: + type: object + properties: + objectSetRid: + type: string + format: rid + x-safety: safe + required: + - objectSetRid + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - enum: - - ALL - - NONE - AsyncApplyActionRequestV2: + PropertiesNotSearchable: + description: | + Search is not enabled on the specified properties. Please mark the properties as *Searchable* + in the **Ontology Manager** to enable search on them. There may be a short delay + between the time a property is marked *Searchable* and when it can be used. properties: parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - type: object - x-namespace: Ontologies - AsyncApplyActionOperationResponseV2: - type: object + properties: + propertyApiNames: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - AsyncApplyActionOperationV2: - x-type: - type: asyncOperation - operationType: applyActionAsyncV2 - resultType: AsyncApplyActionOperationResponseV2 - stageType: AsyncActionStatus + PropertiesNotFilterable: + description: | + Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and + *Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay + between the time a property is marked *Searchable* and *Selectable* and when it can be used. + properties: + parameters: + properties: + properties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - AttachmentV2: - type: object + PropertyApiNameNotFound: + description: | + A property that was required to have an API name, such as a primary key, is missing one. You can set an API + name for it using the **Ontology Manager**. + properties: + parameters: + properties: + propertyId: + $ref: "#/components/schemas/PropertyId" + propertyBaseType: + $ref: "#/components/schemas/ValueType" + required: + - propertyBaseType + - propertyId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - description: The representation of an attachment. + PropertyBaseTypeNotSupported: + description: | + The type of the requested property is not currently supported by this API. If you need support for this, + please reach out to Palantir Support. properties: - rid: - $ref: "#/components/schemas/AttachmentRid" - filename: - $ref: "#/components/schemas/Filename" - sizeBytes: - $ref: "#/components/schemas/SizeBytes" - mediaType: - $ref: "#/components/schemas/MediaType" - required: - - rid - - filename - - sizeBytes - - mediaType - ListLinkedObjectsResponseV2: - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + property: + $ref: "#/components/schemas/PropertyApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" + required: + - objectType + - property + - propertyBaseType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + PropertyFiltersNotSupported: + description: | + At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for + a list of supported property filters. properties: - data: - items: - $ref: "#/components/schemas/OntologyObjectV2" - type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - ListObjectsResponseV2: - type: object + parameters: + properties: + propertyFilters: + items: + $ref: "#/components/schemas/PropertyFilter" + type: array + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + PropertyTypesSearchNotSupported: + description: | + The search on the property types are not supported. See the `Search Objects` documentation for + a list of supported search queries on different property types. properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - type: array - description: The list of objects in the current page. - items: - $ref: "#/components/schemas/OntologyObjectV2" - totalCount: - $ref: "#/components/schemas/TotalCount" - required: - - totalCount - CountObjectsResponseV2: - type: object + parameters: + properties: + parameters: + additionalProperties: + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + x-mapKey: + $ref: "#/components/schemas/PropertyFilter" + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidRangeQuery: + description: | + The specified query range filter is invalid. properties: - count: - type: integer - x-safety: unsafe - LoadObjectSetResponseV2: - description: Represents the API response when loading an `ObjectSet`. - type: object + parameters: + properties: + lt: + description: Less than + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + lte: + description: Less than or equal + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + field: + type: string + x-safety: unsafe + required: + - field + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + QueryNotFound: + description: "The query is not found, or the user does not have access to it." properties: - data: - type: array - description: The list of objects in the current Page. - items: - $ref: "#/components/schemas/OntologyObjectV2" - nextPageToken: - $ref: "#/components/schemas/PageToken" - totalCount: - $ref: "#/components/schemas/TotalCount" - required: - - totalCount - LoadObjectSetRequestV2: - description: Represents the API POST body when loading an `ObjectSet`. - type: object + parameters: + properties: + query: + $ref: "#/components/schemas/QueryApiName" + required: + - query + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + UnknownParameter: + description: | + The provided parameters were not found. Please look at the `knownParameters` field + to see which ones are available. properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - orderBy: - $ref: "#/components/schemas/SearchOrderByV2" - select: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - pageToken: - $ref: "#/components/schemas/PageToken" - pageSize: - $ref: "#/components/schemas/PageSize" - excludeRid: - description: | - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - type: boolean - x-safety: safe - required: - - objectSet - ObjectSet: - description: Represents the definition of an `ObjectSet` in the `Ontology`. + parameters: + properties: + unknownParameters: + items: + $ref: "#/components/schemas/ParameterId" + type: array + expectedParameters: + items: + $ref: "#/components/schemas/ParameterId" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryEncounteredUserFacingError: + description: | + The authored `Query` failed to execute because of a user induced error. The message argument + is meant to be displayed to the user. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + message: + type: string + x-safety: unsafe + required: + - functionRid + - functionVersion + - message + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryRuntimeError: + description: | + The authored `Query` failed to execute because of a runtime error. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + message: + type: string + x-safety: unsafe + stacktrace: + type: string + x-safety: unsafe + parameters: + additionalProperties: + type: string + x-safety: unsafe + x-mapKey: + $ref: "#/components/schemas/QueryRuntimeErrorParameter" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryRuntimeErrorParameter: + type: string + x-namespace: Ontologies + x-safety: unsafe + QueryTimeExceededLimit: + description: | + Time limits were exceeded for the `Query` execution. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - TIMEOUT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryMemoryExceededLimit: + description: | + Memory limits were exceeded for the `Query` execution. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - TIMEOUT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + SearchJsonQuery: type: object x-namespace: Ontologies discriminator: propertyName: type mapping: - base: "#/components/schemas/ObjectSetBaseType" - static: "#/components/schemas/ObjectSetStaticType" - reference: "#/components/schemas/ObjectSetReferenceType" - filter: "#/components/schemas/ObjectSetFilterType" - union: "#/components/schemas/ObjectSetUnionType" - intersect: "#/components/schemas/ObjectSetIntersectionType" - subtract: "#/components/schemas/ObjectSetSubtractType" - searchAround: "#/components/schemas/ObjectSetSearchAroundType" + lt: "#/components/schemas/LtQuery" + gt: "#/components/schemas/GtQuery" + lte: "#/components/schemas/LteQuery" + gte: "#/components/schemas/GteQuery" + eq: "#/components/schemas/EqualsQuery" + isNull: "#/components/schemas/IsNullQuery" + contains: "#/components/schemas/ContainsQuery" + and: "#/components/schemas/AndQuery" + or: "#/components/schemas/OrQuery" + not: "#/components/schemas/NotQuery" + prefix: "#/components/schemas/PrefixQuery" + phrase: "#/components/schemas/PhraseQuery" + anyTerm: "#/components/schemas/AnyTermQuery" + allTerms: "#/components/schemas/AllTermsQuery" oneOf: - - $ref: "#/components/schemas/ObjectSetBaseType" - - $ref: "#/components/schemas/ObjectSetStaticType" - - $ref: "#/components/schemas/ObjectSetReferenceType" - - $ref: "#/components/schemas/ObjectSetFilterType" - - $ref: "#/components/schemas/ObjectSetUnionType" - - $ref: "#/components/schemas/ObjectSetIntersectionType" - - $ref: "#/components/schemas/ObjectSetSubtractType" - - $ref: "#/components/schemas/ObjectSetSearchAroundType" - ObjectSetBaseType: + - $ref: "#/components/schemas/LtQuery" + - $ref: "#/components/schemas/GtQuery" + - $ref: "#/components/schemas/LteQuery" + - $ref: "#/components/schemas/GteQuery" + - $ref: "#/components/schemas/EqualsQuery" + - $ref: "#/components/schemas/IsNullQuery" + - $ref: "#/components/schemas/ContainsQuery" + - $ref: "#/components/schemas/AndQuery" + - $ref: "#/components/schemas/OrQuery" + - $ref: "#/components/schemas/NotQuery" + - $ref: "#/components/schemas/PrefixQuery" + - $ref: "#/components/schemas/PhraseQuery" + - $ref: "#/components/schemas/AnyTermQuery" + - $ref: "#/components/schemas/AllTermsQuery" + LtQuery: type: object x-namespace: Ontologies + description: Returns objects where the specified field is less than a value. properties: - objectType: - type: string - x-safety: unsafe + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" required: - - objectType - ObjectSetStaticType: - type: object - x-namespace: Ontologies - properties: - objects: - type: array - items: - $ref: "#/components/schemas/ObjectRid" - ObjectSetReferenceType: + - field + - value + GtQuery: type: object x-namespace: Ontologies + description: Returns objects where the specified field is greater than a value. properties: - reference: - type: string - format: rid - x-safety: safe + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" required: - - reference - ObjectSetFilterType: + - field + - value + LteQuery: type: object x-namespace: Ontologies + description: Returns objects where the specified field is less than or equal to a value. properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - where: - $ref: "#/components/schemas/SearchJsonQueryV2" + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" required: - - objectSet - - where - ObjectSetUnionType: + - field + - value + GteQuery: type: object x-namespace: Ontologies + description: Returns objects where the specified field is greater than or equal to a value. properties: - objectSets: - type: array - items: - $ref: "#/components/schemas/ObjectSet" - ObjectSetIntersectionType: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + EqualsQuery: type: object x-namespace: Ontologies + description: Returns objects where the specified field is equal to a value. properties: - objectSets: - type: array - items: - $ref: "#/components/schemas/ObjectSet" - ObjectSetSubtractType: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + IsNullQuery: type: object x-namespace: Ontologies + description: Returns objects based on the existence of the specified field. properties: - objectSets: - type: array - items: - $ref: "#/components/schemas/ObjectSet" - ObjectSetSearchAroundType: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: boolean + x-safety: unsafe + required: + - field + - value + ContainsQuery: type: object x-namespace: Ontologies + description: Returns objects where the specified array contains a value. properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - link: - $ref: "#/components/schemas/LinkTypeApiName" + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" required: - - objectSet - - link - OntologyV2: - $ref: "#/components/schemas/Ontology" - OntologyFullMetadata: + - field + - value + AndQuery: + type: object + x-namespace: Ontologies + description: Returns objects where every query is satisfied. properties: - ontology: - $ref: "#/components/schemas/OntologyV2" - objectTypes: - additionalProperties: - $ref: "#/components/schemas/ObjectTypeFullMetadata" - x-mapKey: - $ref: "#/components/schemas/ObjectTypeApiName" - actionTypes: - additionalProperties: - $ref: "#/components/schemas/ActionTypeV2" - x-mapKey: - $ref: "#/components/schemas/ActionTypeApiName" - queryTypes: - additionalProperties: - $ref: "#/components/schemas/QueryTypeV2" - x-mapKey: - $ref: "#/components/schemas/QueryApiName" - interfaceTypes: - additionalProperties: - $ref: "#/components/schemas/InterfaceType" - x-mapKey: - $ref: "#/components/schemas/InterfaceTypeApiName" - sharedPropertyTypes: - additionalProperties: - $ref: "#/components/schemas/SharedPropertyType" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" + value: + items: + $ref: "#/components/schemas/SearchJsonQuery" + type: array + OrQuery: type: object x-namespace: Ontologies - required: - - ontology - OntologyObjectV2: - description: Represents an object in the Ontology. - additionalProperties: - $ref: "#/components/schemas/PropertyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" + description: Returns objects where at least 1 query is satisfied. + properties: + value: + items: + $ref: "#/components/schemas/SearchJsonQuery" + type: array + NotQuery: + type: object x-namespace: Ontologies - OntologyIdentifier: - description: Either an ontology rid or an ontology api name. - type: string - x-safety: unsafe + description: Returns objects where the query is not satisfied. + properties: + value: + $ref: "#/components/schemas/SearchJsonQuery" + required: + - value + PrefixQuery: + type: object x-namespace: Ontologies - QueryTypeV2: - description: Represents a query type in the Ontology. + description: Returns objects where the specified field starts with the provided value. properties: - apiName: - $ref: "#/components/schemas/QueryApiName" - description: + field: + $ref: "#/components/schemas/FieldNameV1" + value: type: string x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - parameters: - additionalProperties: - $ref: "#/components/schemas/QueryParameterV2" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - output: - $ref: "#/components/schemas/QueryDataType" - rid: - $ref: "#/components/schemas/FunctionRid" - version: - $ref: "#/components/schemas/FunctionVersion" required: - - apiName - - rid - - version - - output + - field + - value + PhraseQuery: type: object x-namespace: Ontologies - QueryParameterV2: - type: object - description: Details about a parameter of a query. + description: Returns objects where the specified field contains the provided value as a substring. properties: - description: + field: + $ref: "#/components/schemas/FieldNameV1" + value: type: string x-safety: unsafe - dataType: - $ref: "#/components/schemas/QueryDataType" required: - - dataType - QueryOutputV2: + - field + - value + AnyTermQuery: type: object - description: Details about the output of a query. + x-namespace: Ontologies + 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" properties: - dataType: - $ref: "#/components/schemas/QueryDataType" - required: - type: boolean - x-safety: safe + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: string + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/Fuzzy" required: - - dataType - - required - RelativeTimeSeriesTimeUnit: - enum: - - MILLISECONDS - - SECONDS - - MINUTES - - HOURS - - DAYS - - WEEKS - - MONTHS - - YEARS - RelativeTime: - description: | - A relative time, such as "3 days before" or "2 hours after" the current moment. + - field + - value + AllTermsQuery: type: object x-namespace: Ontologies + description: | + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. properties: - when: - $ref: "#/components/schemas/RelativeTimeRelation" + field: + $ref: "#/components/schemas/FieldNameV1" value: - type: integer + type: string x-safety: unsafe - unit: - $ref: "#/components/schemas/RelativeTimeSeriesTimeUnit" + fuzzy: + $ref: "#/components/schemas/Fuzzy" required: - - when + - field - value - - unit - RelativeTimeRelation: - enum: - - BEFORE - - AFTER - RelativeTimeRange: - description: | - A relative time range for a time series query. + Fuzzy: + description: Setting fuzzy to `true` allows approximate matching in search queries that support it. + type: boolean + x-namespace: Ontologies + x-safety: safe + SearchOrderBy: + description: Specifies the ordering of search results by a field and an ordering direction. type: object x-namespace: Ontologies properties: - startTime: - $ref: "#/components/schemas/RelativeTime" - endTime: - $ref: "#/components/schemas/RelativeTime" - SearchObjectsRequestV2: + fields: + items: + $ref: "#/components/schemas/SearchOrdering" + type: array + SearchOrdering: type: object x-namespace: Ontologies properties: - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - orderBy: - $ref: "#/components/schemas/SearchOrderByV2" - pageSize: - $ref: "#/components/schemas/PageSize" - pageToken: - $ref: "#/components/schemas/PageToken" - select: - description: | - The API names of the object type properties to include in the response. - type: array - items: - $ref: "#/components/schemas/PropertyApiName" - excludeRid: - description: | - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - type: boolean + field: + $ref: "#/components/schemas/FieldNameV1" + direction: + description: Specifies the ordering direction (can be either `asc` or `desc`) + type: string x-safety: safe - SearchObjectsResponseV2: - type: object - x-namespace: Ontologies - properties: - data: - items: - $ref: "#/components/schemas/OntologyObjectV2" - type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - totalCount: - $ref: "#/components/schemas/TotalCount" required: - - totalCount - StreamTimeSeriesPointsRequest: + - field + AggregationMetricName: + type: string + x-namespace: Ontologies + description: A user-specified alias for an aggregation metric name. + x-safety: unsafe + AggregationRange: + description: Specifies a date range from an inclusive start date to an exclusive end date. type: object x-namespace: Ontologies properties: - range: - $ref: "#/components/schemas/TimeRange" - StreamTimeSeriesPointsResponse: + lt: + description: Exclusive end date. + x-safety: unsafe + lte: + description: Inclusive end date. + x-safety: unsafe + gt: + description: Exclusive start date. + x-safety: unsafe + gte: + description: Inclusive start date. + x-safety: unsafe + Aggregation: + description: Specifies an aggregation function. type: object x-namespace: Ontologies - properties: - data: - items: - $ref: "#/components/schemas/TimeSeriesPoint" - type: array - TimeRange: - description: An absolute or relative range for a time series query. + discriminator: + propertyName: type + mapping: + max: "#/components/schemas/MaxAggregation" + min: "#/components/schemas/MinAggregation" + avg: "#/components/schemas/AvgAggregation" + sum: "#/components/schemas/SumAggregation" + count: "#/components/schemas/CountAggregation" + approximateDistinct: "#/components/schemas/ApproximateDistinctAggregation" + oneOf: + - $ref: "#/components/schemas/MaxAggregation" + - $ref: "#/components/schemas/MinAggregation" + - $ref: "#/components/schemas/AvgAggregation" + - $ref: "#/components/schemas/SumAggregation" + - $ref: "#/components/schemas/CountAggregation" + - $ref: "#/components/schemas/ApproximateDistinctAggregation" + AggregationGroupBy: + description: Specifies a grouping for aggregation results. type: object x-namespace: Ontologies discriminator: propertyName: type mapping: - absolute: "#/components/schemas/AbsoluteTimeRange" - relative: "#/components/schemas/RelativeTimeRange" + fixedWidth: "#/components/schemas/AggregationFixedWidthGrouping" + ranges: "#/components/schemas/AggregationRangesGrouping" + exact: "#/components/schemas/AggregationExactGrouping" + duration: "#/components/schemas/AggregationDurationGrouping" oneOf: - - $ref: "#/components/schemas/AbsoluteTimeRange" - - $ref: "#/components/schemas/RelativeTimeRange" - TimeSeriesPoint: - description: | - A time and value pair. + - $ref: "#/components/schemas/AggregationFixedWidthGrouping" + - $ref: "#/components/schemas/AggregationRangesGrouping" + - $ref: "#/components/schemas/AggregationExactGrouping" + - $ref: "#/components/schemas/AggregationDurationGrouping" + AggregationOrderBy: type: object + x-namespace: Ontologies properties: - time: - description: An ISO 8601 timestamp + metricName: type: string - format: date-time - x-safety: unsafe - value: - description: An object which is either an enum String or a double number. x-safety: unsafe required: - - time - - value - ValidateActionResponseV2: + - metricName + AggregationFixedWidthGrouping: + description: Divides objects into groups with the specified width. type: object x-namespace: Ontologies properties: - result: - $ref: "#/components/schemas/ValidationResult" - submissionCriteria: + field: + $ref: "#/components/schemas/FieldNameV1" + fixedWidth: + type: integer + x-safety: safe + required: + - field + - fixedWidth + AggregationRangesGrouping: + description: Divides objects into groups according to specified ranges. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + ranges: items: - $ref: "#/components/schemas/SubmissionCriteriaEvaluation" + $ref: "#/components/schemas/AggregationRange" type: array - parameters: - additionalProperties: - $ref: "#/components/schemas/ParameterEvaluationResult" - x-mapKey: - $ref: "#/components/schemas/ParameterId" required: - - result - PropertyV2: - description: Details about some property of an object. + - field + AggregationExactGrouping: + description: Divides objects into groups according to an exact value. + type: object + x-namespace: Ontologies properties: - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - dataType: - $ref: "#/components/schemas/ObjectPropertyType" + field: + $ref: "#/components/schemas/FieldNameV1" + maxGroupCount: + type: integer + x-safety: safe required: - - dataType + - field + AggregationDurationGrouping: + description: | + Divides objects into groups according to an interval. Note that this grouping applies only on date types. + The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. type: object x-namespace: Ontologies - OntologyObjectArrayType: + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + duration: + $ref: "#/components/schemas/Duration" + required: + - field + - duration + MaxAggregation: + description: Computes the maximum value for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + MinAggregation: + description: Computes the minimum value for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + AvgAggregation: + description: Computes the average value for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + SumAggregation: + description: Computes the sum of values for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + CountAggregation: + description: Computes the total count of objects. + type: object + x-namespace: Ontologies + properties: + name: + $ref: "#/components/schemas/AggregationMetricName" + ApproximateDistinctAggregation: + description: Computes an approximate number of distinct values for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + ActionParameterArrayType: type: object properties: subType: - $ref: "#/components/schemas/ObjectPropertyType" + $ref: "#/components/schemas/ActionParameterType" required: - subType - ObjectPropertyType: + ActionParameterType: description: | - A union of all the types supported by Ontology Object properties. + A union of all the types supported by Ontology Action parameters. discriminator: propertyName: type mapping: - array: "#/components/schemas/OntologyObjectArrayType" + array: "#/components/schemas/ActionParameterArrayType" attachment: "#/components/schemas/AttachmentType" boolean: "#/components/schemas/BooleanType" - byte: "#/components/schemas/ByteType" date: "#/components/schemas/DateType" - decimal: "#/components/schemas/DecimalType" double: "#/components/schemas/DoubleType" - float: "#/components/schemas/FloatType" - geopoint: "#/components/schemas/GeoPointType" - geoshape: "#/components/schemas/GeoShapeType" integer: "#/components/schemas/IntegerType" long: "#/components/schemas/LongType" marking: "#/components/schemas/MarkingType" - short: "#/components/schemas/ShortType" + objectSet: "#/components/schemas/OntologyObjectSetType" + object: "#/components/schemas/OntologyObjectType" string: "#/components/schemas/StringType" timestamp: "#/components/schemas/TimestampType" - timeseries: "#/components/schemas/TimeseriesType" oneOf: - - $ref: "#/components/schemas/OntologyObjectArrayType" + - $ref: "#/components/schemas/ActionParameterArrayType" - $ref: "#/components/schemas/AttachmentType" - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/ByteType" - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DecimalType" - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/FloatType" - - $ref: "#/components/schemas/GeoPointType" - - $ref: "#/components/schemas/GeoShapeType" - $ref: "#/components/schemas/IntegerType" - $ref: "#/components/schemas/LongType" - $ref: "#/components/schemas/MarkingType" - - $ref: "#/components/schemas/ShortType" + - $ref: "#/components/schemas/OntologyObjectSetType" + - $ref: "#/components/schemas/OntologyObjectType" - $ref: "#/components/schemas/StringType" - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/TimeseriesType" - BlueprintIcon: - type: object - properties: - color: - description: A hexadecimal color code. - type: string - x-safety: safe - name: - 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" - type: string - x-safety: unsafe - required: - - color - - name - Icon: - description: A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). + OntologyDataType: + description: | + A union of all the primitive types used by Palantir's Ontology-based products. discriminator: propertyName: type mapping: - blueprint: "#/components/schemas/BlueprintIcon" + any: "#/components/schemas/AnyType" + binary: "#/components/schemas/BinaryType" + boolean: "#/components/schemas/BooleanType" + byte: "#/components/schemas/ByteType" + date: "#/components/schemas/DateType" + decimal: "#/components/schemas/DecimalType" + double: "#/components/schemas/DoubleType" + float: "#/components/schemas/FloatType" + integer: "#/components/schemas/IntegerType" + long: "#/components/schemas/LongType" + marking: "#/components/schemas/MarkingType" + short: "#/components/schemas/ShortType" + string: "#/components/schemas/StringType" + timestamp: "#/components/schemas/TimestampType" + array: "#/components/schemas/OntologyArrayType" + map: "#/components/schemas/OntologyMapType" + set: "#/components/schemas/OntologySetType" + struct: "#/components/schemas/OntologyStructType" + object: "#/components/schemas/OntologyObjectType" + objectSet: "#/components/schemas/OntologyObjectSetType" + unsupported: "#/components/schemas/UnsupportedType" oneOf: - - $ref: "#/components/schemas/BlueprintIcon" - ObjectTypeV2: - description: Represents an object type in the Ontology. + - $ref: "#/components/schemas/AnyType" + - $ref: "#/components/schemas/BinaryType" + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/ByteType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DecimalType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/FloatType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/LongType" + - $ref: "#/components/schemas/MarkingType" + - $ref: "#/components/schemas/ShortType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/OntologyArrayType" + - $ref: "#/components/schemas/OntologyMapType" + - $ref: "#/components/schemas/OntologySetType" + - $ref: "#/components/schemas/OntologyStructType" + - $ref: "#/components/schemas/OntologyObjectType" + - $ref: "#/components/schemas/OntologyObjectSetType" + - $ref: "#/components/schemas/UnsupportedType" + OntologyObjectSetType: + type: object properties: - apiName: + objectApiName: $ref: "#/components/schemas/ObjectTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - description: - description: The description of the object type. - type: string - x-safety: unsafe - pluralDisplayName: - description: The plural display name of the object type. - type: string - x-safety: unsafe - icon: - $ref: "#/components/schemas/Icon" - primaryKey: - $ref: "#/components/schemas/PropertyApiName" - properties: - description: A map of the properties of the object type. - additionalProperties: - $ref: "#/components/schemas/PropertyV2" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - rid: - $ref: "#/components/schemas/ObjectTypeRid" - titleProperty: - $ref: "#/components/schemas/PropertyApiName" - visibility: - $ref: "#/components/schemas/ObjectTypeVisibility" - required: - - apiName - - status - - rid - - primaryKey - - titleProperty - - displayName - - pluralDisplayName - - icon + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + OntologyObjectType: type: object - x-namespace: Ontologies - ListObjectTypesV2Response: properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of object types in the current page. - items: - $ref: "#/components/schemas/ObjectTypeV2" - type: array + objectApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectApiName + - objectTypeApiName + OntologyArrayType: type: object - x-namespace: Ontologies - ListOntologiesV2Response: properties: - data: - description: The list of Ontologies the user has access to. - items: - $ref: "#/components/schemas/OntologyV2" - type: array + itemType: + $ref: "#/components/schemas/OntologyDataType" + required: + - itemType + OntologyMapType: type: object - x-namespace: Ontologies - ObjectTypeInterfaceImplementation: properties: - properties: - additionalProperties: - $ref: "#/components/schemas/PropertyApiName" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" + keyType: + $ref: "#/components/schemas/OntologyDataType" + valueType: + $ref: "#/components/schemas/OntologyDataType" + required: + - keyType + - valueType + OntologySetType: type: object - x-namespace: Ontologies - ObjectTypeFullMetadata: properties: - objectType: - $ref: "#/components/schemas/ObjectTypeV2" - linkTypes: - type: array - items: - $ref: "#/components/schemas/LinkTypeSideV2" - implementsInterfaces: - description: A list of interfaces that this object type implements. - type: array - items: - $ref: "#/components/schemas/InterfaceTypeApiName" - implementsInterfaces2: - description: A list of interfaces that this object type implements and how it implements them. - additionalProperties: - $ref: "#/components/schemas/ObjectTypeInterfaceImplementation" - x-mapKey: - $ref: "#/components/schemas/InterfaceTypeApiName" - x-safety: unsafe - sharedPropertyTypeMapping: - 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" - additionalProperties: - $ref: "#/components/schemas/PropertyApiName" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: object - x-namespace: Ontologies + itemType: + $ref: "#/components/schemas/OntologyDataType" required: - - objectType - InterfaceTypeApiName: - description: | - The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface - type, use the `List interface types` endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - InterfaceTypeRid: - description: "The unique resource identifier of an interface, useful for interacting with other Foundry APIs." - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - InterfaceLinkTypeRid: - description: | - The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - InterfaceLinkTypeApiName: - description: A string indicating the API name to use for the interface link. - type: string - x-namespace: Ontologies - x-safety: unsafe - LinkedInterfaceTypeApiName: - description: A reference to the linked interface type. + - itemType + OntologyStructType: type: object properties: - apiName: - $ref: "#/components/schemas/InterfaceTypeApiName" - required: - - apiName - LinkedObjectTypeApiName: - description: A reference to the linked object type. + fields: + type: array + items: + $ref: "#/components/schemas/OntologyStructField" + OntologyStructField: type: object properties: - apiName: - $ref: "#/components/schemas/ObjectTypeApiName" + name: + $ref: "#/components/schemas/StructFieldName" + fieldType: + $ref: "#/components/schemas/OntologyDataType" + required: + type: boolean + x-safety: safe required: - - apiName - InterfaceLinkTypeLinkedEntityApiName: - description: A reference to the linked entity. This can either be an object or an interface type. + - name + - required + - fieldType + QueryDataType: + description: | + A union of all the types supported by Ontology Query parameters or outputs. discriminator: propertyName: type mapping: - interfaceTypeApiName: "#/components/schemas/LinkedInterfaceTypeApiName" - objectTypeApiName: "#/components/schemas/LinkedObjectTypeApiName" - oneOf: - - $ref: "#/components/schemas/LinkedInterfaceTypeApiName" - - $ref: "#/components/schemas/LinkedObjectTypeApiName" - InterfaceLinkTypeCardinality: - description: | - The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can - link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. - enum: - - ONE - - MANY - InterfaceLinkType: - description: | - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - type: object - x-namespace: Ontologies + array: "#/components/schemas/QueryArrayType" + attachment: "#/components/schemas/AttachmentType" + boolean: "#/components/schemas/BooleanType" + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + float: "#/components/schemas/FloatType" + integer: "#/components/schemas/IntegerType" + long: "#/components/schemas/LongType" + objectSet: "#/components/schemas/OntologyObjectSetType" + object: "#/components/schemas/OntologyObjectType" + set: "#/components/schemas/QuerySetType" + string: "#/components/schemas/StringType" + struct: "#/components/schemas/QueryStructType" + threeDimensionalAggregation: "#/components/schemas/ThreeDimensionalAggregation" + timestamp: "#/components/schemas/TimestampType" + twoDimensionalAggregation: "#/components/schemas/TwoDimensionalAggregation" + union: "#/components/schemas/QueryUnionType" + "null": "#/components/schemas/NullType" + unsupported: "#/components/schemas/UnsupportedType" + oneOf: + - $ref: "#/components/schemas/QueryArrayType" + - $ref: "#/components/schemas/AttachmentType" + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/FloatType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/LongType" + - $ref: "#/components/schemas/OntologyObjectSetType" + - $ref: "#/components/schemas/OntologyObjectType" + - $ref: "#/components/schemas/QuerySetType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/QueryStructType" + - $ref: "#/components/schemas/ThreeDimensionalAggregation" + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/TwoDimensionalAggregation" + - $ref: "#/components/schemas/QueryUnionType" + - $ref: "#/components/schemas/NullType" + - $ref: "#/components/schemas/UnsupportedType" + QueryArrayType: + type: object properties: - rid: - $ref: "#/components/schemas/InterfaceLinkTypeRid" - apiName: - $ref: "#/components/schemas/InterfaceLinkTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - description: The description of the interface link type. - type: string - x-safety: unsafe - linkedEntityApiName: - $ref: "#/components/schemas/InterfaceLinkTypeLinkedEntityApiName" - cardinality: - $ref: "#/components/schemas/InterfaceLinkTypeCardinality" - required: - description: | - Whether each implementing object type must declare at least one implementation of this link. - type: boolean - x-safety: safe + subType: + $ref: "#/components/schemas/QueryDataType" required: - - rid - - apiName - - displayName - - linkedEntityApiName - - cardinality - - required - InterfaceType: + - subType + QuerySetType: type: object - x-namespace: Ontologies - description: Represents an interface type in the Ontology. properties: - rid: - $ref: "#/components/schemas/InterfaceTypeRid" - apiName: - $ref: "#/components/schemas/InterfaceTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - description: The description of the interface. - type: string - x-safety: unsafe - properties: - 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.\n" - additionalProperties: - $ref: "#/components/schemas/SharedPropertyType" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - extendsInterfaces: - description: "A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n" + subType: + $ref: "#/components/schemas/QueryDataType" + required: + - subType + QueryStructType: + type: object + properties: + fields: type: array items: - $ref: "#/components/schemas/InterfaceTypeApiName" - links: - description: | - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - additionalProperties: - $ref: "#/components/schemas/InterfaceLinkType" - x-mapKey: - $ref: "#/components/schemas/InterfaceLinkTypeApiName" + $ref: "#/components/schemas/QueryStructField" + QueryStructField: + type: object + properties: + name: + $ref: "#/components/schemas/StructFieldName" + fieldType: + $ref: "#/components/schemas/QueryDataType" required: - - rid - - apiName - - displayName - InterfaceTypeNotFound: - description: "The requested interface type is not found, or the client token does not have access to it." + - name + - fieldType + QueryUnionType: + type: object properties: - parameters: - properties: - apiName: - $ref: "#/components/schemas/InterfaceTypeApiName" - rid: - $ref: "#/components/schemas/InterfaceTypeRid" - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - SharedPropertyTypeNotFound: - description: "The requested shared property type is not found, or the client token does not have access to it." + unionTypes: + type: array + items: + $ref: "#/components/schemas/QueryDataType" + QueryAggregationRangeType: + type: object properties: - parameters: - properties: - apiName: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - rid: - $ref: "#/components/schemas/SharedPropertyTypeRid" - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertiesHaveDifferentIds: + subType: + $ref: "#/components/schemas/QueryAggregationRangeSubType" + required: + - subType + QueryAggregationRangeSubType: description: | - Properties used in ordering must have the same ids. Temporary restriction imposed due to OSS limitations. + A union of all the types supported by query aggregation ranges. + discriminator: + propertyName: type + mapping: + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + integer: "#/components/schemas/IntegerType" + timestamp: "#/components/schemas/TimestampType" + oneOf: + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/TimestampType" + QueryAggregationKeyType: + description: | + A union of all the types supported by query aggregation keys. + discriminator: + propertyName: type + mapping: + boolean: "#/components/schemas/BooleanType" + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + integer: "#/components/schemas/IntegerType" + string: "#/components/schemas/StringType" + timestamp: "#/components/schemas/TimestampType" + range: "#/components/schemas/QueryAggregationRangeType" + oneOf: + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/QueryAggregationRangeType" + QueryAggregationValueType: + description: | + A union of all the types supported by query aggregation keys. + discriminator: + propertyName: type + mapping: + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + timestamp: "#/components/schemas/TimestampType" + oneOf: + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/TimestampType" + TwoDimensionalAggregation: + type: object properties: - parameters: - properties: - properties: - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - SharedPropertiesNotFound: - description: The requested shared property types are not present on every object type. + keyType: + $ref: "#/components/schemas/QueryAggregationKeyType" + valueType: + $ref: "#/components/schemas/QueryAggregationValueType" + required: + - keyType + - valueType + ThreeDimensionalAggregation: + type: object properties: - parameters: - properties: - objectType: - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - missingSharedProperties: - type: array - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + keyType: + $ref: "#/components/schemas/QueryAggregationKeyType" + valueType: + $ref: "#/components/schemas/TwoDimensionalAggregation" + required: + - keyType + - valueType + ValueType: + type: string + x-safety: safe + description: | + A string indicating the type of each data value. Note that these types can be nested, for example an array of + structs. + + | Type | JSON value | + |---------------------|-------------------------------------------------------------------------------------------------------------------| + | Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | + | Attachment | `Attachment` | + | Boolean | `Boolean` | + | Byte | `Byte` | + | Date | `LocalDate` | + | Decimal | `Decimal` | + | Double | `Double` | + | Float | `Float` | + | Integer | `Integer` | + | Long | `Long` | + | Marking | `Marking` | + | OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | + | Short | `Short` | + | String | `String` | + | Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | + | Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | + | Timestamp | `Timestamp` | + ArraySizeConstraint: + description: | + The parameter expects an array of values and the size of the array must fall within the defined range. + type: object + properties: + lt: + description: Less than + x-safety: unsafe + lte: + description: Less than or equal + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + GroupMemberConstraint: + description: | + The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. + type: object x-namespace: Ontologies - SharedPropertyTypeApiName: + ObjectPropertyValueConstraint: description: | - The name of the shared property type in the API in lowerCamelCase format. To find the API name for your - shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. - type: string + The parameter value must be a property value of an object found within an object set. + type: object x-namespace: Ontologies - x-safety: unsafe - SharedPropertyTypeRid: + ObjectQueryResultConstraint: description: | - The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. - format: rid - type: string + The parameter value must be the primary key of an object found within an object set. + type: object x-namespace: Ontologies - x-safety: safe - SharedPropertyType: + OneOfConstraint: + description: | + The parameter has a manually predefined set of options. type: object x-namespace: Ontologies - description: A property type that can be shared across object types. properties: - rid: - $ref: "#/components/schemas/SharedPropertyTypeRid" - apiName: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - type: string - description: A short text that describes the SharedPropertyType. + options: + type: array + items: + $ref: "#/components/schemas/ParameterOption" + otherValuesAllowed: + 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**." + type: boolean x-safety: unsafe - dataType: - $ref: "#/components/schemas/ObjectPropertyType" required: - - rid - - apiName - - displayName - - dataType - InvalidApplyActionOptionCombination: - description: The given options are individually valid but cannot be used in the given combination. - properties: - parameters: - properties: - invalidCombination: - $ref: "#/components/schemas/ApplyActionRequestOptions" - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - ActionContainsDuplicateEdits: - description: The given action request has multiple edits on the same object. - properties: - parameters: - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - ActionEditsReadOnlyEntity: - description: The given action request performs edits on a type that is read-only or does not allow edits. - properties: - parameters: - type: object - properties: - entityTypeRid: - $ref: "#/components/schemas/ObjectTypeRid" - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - ObjectSetNotFound: - description: "The requested object set is not found, or the client token does not have access to it." + - otherValuesAllowed + RangeConstraint: + description: | + The parameter value must be within the defined range. + type: object + x-namespace: Ontologies properties: - parameters: - properties: - objectSetRid: - $ref: "#/components/schemas/ObjectSetRid" - required: - - objectSetRid - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + lt: + description: Less than + x-safety: unsafe + lte: + description: Less than or equal + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + StringLengthConstraint: + description: | + The parameter value must have a length within the defined range. + *This range is always inclusive.* + type: object x-namespace: Ontologies - MarketplaceInstallationNotFound: + properties: + lt: + description: Less than + x-safety: unsafe + lte: + description: Less than or equal + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + StringRegexMatchConstraint: description: | - The given marketplace installation could not be found or the user does not have access to it. + The parameter value must match a predefined regular expression. + type: object + x-namespace: Ontologies properties: - parameters: - properties: - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" - required: - - artifactRepository - - packageName - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: + regex: + description: The regular expression configured in the **Ontology Manager**. type: string - errorInstanceId: + x-safety: unsafe + configuredFailureMessage: + description: | + The message indicating that the regular expression was not matched. + This is configured per parameter in the **Ontology Manager**. type: string - x-type: error - MarketplaceObjectMappingNotFound: - description: The given object could not be mapped to a Marketplace installation. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" - required: - - objectType - - artifactRepository - - packageName - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - MarketplaceActionMappingNotFound: - description: The given action could not be mapped to a Marketplace installation. - properties: - parameters: - properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" - required: - - actionType - - artifactRepository - - packageName - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - MarketplaceQueryMappingNotFound: - description: The given query could not be mapped to a Marketplace installation. - properties: - parameters: - properties: - queryType: - $ref: "#/components/schemas/QueryApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" - required: - - queryType - - artifactRepository - - packageName - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - MarketplaceLinkMappingNotFound: - description: The given link could not be mapped to a Marketplace installation. - properties: - parameters: - properties: - linkType: - $ref: "#/components/schemas/LinkTypeApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" - required: - - linkType - - artifactRepository - - packageName - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - OntologyApiNameNotUnique: - description: The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name. - properties: - parameters: - properties: - ontologyApiName: - $ref: "#/components/schemas/OntologyApiName" - type: object - required: - - ontologyApiName - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - SearchJsonQueryV2: + x-safety: unsafe + required: + - regex + UnevaluableConstraint: + description: | + 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. + type: object + x-namespace: Ontologies + ParameterEvaluatedConstraint: + 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" type: object x-namespace: Ontologies discriminator: propertyName: type mapping: - lt: "#/components/schemas/LtQueryV2" - gt: "#/components/schemas/GtQueryV2" - lte: "#/components/schemas/LteQueryV2" - gte: "#/components/schemas/GteQueryV2" - eq: "#/components/schemas/EqualsQueryV2" - isNull: "#/components/schemas/IsNullQueryV2" - contains: "#/components/schemas/ContainsQueryV2" - and: "#/components/schemas/AndQueryV2" - or: "#/components/schemas/OrQueryV2" - not: "#/components/schemas/NotQueryV2" - startsWith: "#/components/schemas/StartsWithQuery" - containsAllTermsInOrder: "#/components/schemas/ContainsAllTermsInOrderQuery" - containsAllTermsInOrderPrefixLastTerm: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" - containsAnyTerm: "#/components/schemas/ContainsAnyTermQuery" - containsAllTerms: "#/components/schemas/ContainsAllTermsQuery" - withinDistanceOf: "#/components/schemas/WithinDistanceOfQuery" - withinBoundingBox: "#/components/schemas/WithinBoundingBoxQuery" - intersectsBoundingBox: "#/components/schemas/IntersectsBoundingBoxQuery" - doesNotIntersectBoundingBox: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" - withinPolygon: "#/components/schemas/WithinPolygonQuery" - intersectsPolygon: "#/components/schemas/IntersectsPolygonQuery" - doesNotIntersectPolygon: "#/components/schemas/DoesNotIntersectPolygonQuery" + arraySize: "#/components/schemas/ArraySizeConstraint" + groupMember: "#/components/schemas/GroupMemberConstraint" + objectPropertyValue: "#/components/schemas/ObjectPropertyValueConstraint" + objectQueryResult: "#/components/schemas/ObjectQueryResultConstraint" + oneOf: "#/components/schemas/OneOfConstraint" + range: "#/components/schemas/RangeConstraint" + stringLength: "#/components/schemas/StringLengthConstraint" + stringRegexMatch: "#/components/schemas/StringRegexMatchConstraint" + unevaluable: "#/components/schemas/UnevaluableConstraint" oneOf: - - $ref: "#/components/schemas/LtQueryV2" - - $ref: "#/components/schemas/GtQueryV2" - - $ref: "#/components/schemas/LteQueryV2" - - $ref: "#/components/schemas/GteQueryV2" - - $ref: "#/components/schemas/EqualsQueryV2" - - $ref: "#/components/schemas/IsNullQueryV2" - - $ref: "#/components/schemas/ContainsQueryV2" - - $ref: "#/components/schemas/AndQueryV2" - - $ref: "#/components/schemas/OrQueryV2" - - $ref: "#/components/schemas/NotQueryV2" - - $ref: "#/components/schemas/StartsWithQuery" - - $ref: "#/components/schemas/ContainsAllTermsInOrderQuery" - - $ref: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" - - $ref: "#/components/schemas/ContainsAnyTermQuery" - - $ref: "#/components/schemas/ContainsAllTermsQuery" - - $ref: "#/components/schemas/WithinDistanceOfQuery" - - $ref: "#/components/schemas/WithinBoundingBoxQuery" - - $ref: "#/components/schemas/IntersectsBoundingBoxQuery" - - $ref: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" - - $ref: "#/components/schemas/WithinPolygonQuery" - - $ref: "#/components/schemas/IntersectsPolygonQuery" - - $ref: "#/components/schemas/DoesNotIntersectPolygonQuery" - LtQueryV2: + - $ref: "#/components/schemas/ArraySizeConstraint" + - $ref: "#/components/schemas/GroupMemberConstraint" + - $ref: "#/components/schemas/ObjectPropertyValueConstraint" + - $ref: "#/components/schemas/ObjectQueryResultConstraint" + - $ref: "#/components/schemas/OneOfConstraint" + - $ref: "#/components/schemas/RangeConstraint" + - $ref: "#/components/schemas/StringLengthConstraint" + - $ref: "#/components/schemas/StringRegexMatchConstraint" + - $ref: "#/components/schemas/UnevaluableConstraint" + ParameterEvaluationResult: + description: Represents the validity of a parameter against the configured constraints. type: object x-namespace: Ontologies - description: Returns objects where the specified field is less than a value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + result: + $ref: "#/components/schemas/ValidationResult" + evaluatedConstraints: + type: array + items: + $ref: "#/components/schemas/ParameterEvaluatedConstraint" + required: + description: Represents whether the parameter is a required input to the action. + type: boolean + x-safety: unsafe required: - - field - - value - GtQueryV2: + - result + - required + ParameterOption: + description: | + A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. type: object x-namespace: Ontologies - description: Returns objects where the specified field is greater than a value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" + displayName: + $ref: "#/components/schemas/DisplayName" value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - LteQueryV2: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is less than or equal to a value. + description: An allowed configured value for a parameter within an action. + x-safety: unsafe + ActionType: + description: Represents an action type in the Ontology. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + apiName: + $ref: "#/components/schemas/ActionTypeApiName" + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + parameters: + additionalProperties: + $ref: "#/components/schemas/Parameter" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + rid: + $ref: "#/components/schemas/ActionTypeRid" + operations: + type: array + items: + $ref: "#/components/schemas/LogicRule" required: - - field - - value - GteQueryV2: + - apiName + - status + - rid type: object x-namespace: Ontologies - description: Returns objects where the specified field is greater than or equal to a value. + LogicRule: + discriminator: + propertyName: type + mapping: + createObject: "#/components/schemas/CreateObjectRule" + modifyObject: "#/components/schemas/ModifyObjectRule" + deleteObject: "#/components/schemas/DeleteObjectRule" + createLink: "#/components/schemas/CreateLinkRule" + deleteLink: "#/components/schemas/DeleteLinkRule" + oneOf: + - $ref: "#/components/schemas/CreateObjectRule" + - $ref: "#/components/schemas/ModifyObjectRule" + - $ref: "#/components/schemas/DeleteObjectRule" + - $ref: "#/components/schemas/CreateLinkRule" + - $ref: "#/components/schemas/DeleteLinkRule" + CreateObjectRule: + type: object properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - EqualsQueryV2: + - objectTypeApiName + ModifyObjectRule: type: object - x-namespace: Ontologies - description: Returns objects where the specified field is equal to a value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - IsNullQueryV2: + - objectTypeApiName + DeleteObjectRule: type: object - x-namespace: Ontologies - description: Returns objects based on the existence of the specified field. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: boolean - x-safety: unsafe + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - ContainsQueryV2: + - objectTypeApiName + CreateLinkRule: type: object - x-namespace: Ontologies - description: Returns objects where the specified array contains a value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + linkTypeApiNameAtoB: + $ref: "#/components/schemas/LinkTypeApiName" + linkTypeApiNameBtoA: + $ref: "#/components/schemas/LinkTypeApiName" + aSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + bSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - AndQueryV2: + - linkTypeApiNameAtoB + - linkTypeApiNameBtoA + - aSideObjectTypeApiName + - bSideObjectTypeApiName + DeleteLinkRule: type: object + properties: + linkTypeApiNameAtoB: + $ref: "#/components/schemas/LinkTypeApiName" + linkTypeApiNameBtoA: + $ref: "#/components/schemas/LinkTypeApiName" + aSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + bSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - linkTypeApiNameAtoB + - linkTypeApiNameBtoA + - aSideObjectTypeApiName + - bSideObjectTypeApiName + ActionTypeApiName: + description: | + The name of the action type in the API. To find the API name for your Action Type, use the `List action types` + endpoint or check the **Ontology Manager**. + type: string + x-safety: unsafe x-namespace: Ontologies - description: Returns objects where every query is satisfied. + ActionTypeRid: + description: | + The unique resource identifier of an action type, useful for interacting with other Foundry APIs. + format: rid + type: string + x-safety: safe + x-namespace: Ontologies + ApplyActionRequest: properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQueryV2" - type: array - OrQueryV2: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - description: Returns objects where at least 1 query is satisfied. + BatchApplyActionRequest: properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQueryV2" + requests: type: array - NotQueryV2: + items: + $ref: "#/components/schemas/ApplyActionRequest" type: object x-namespace: Ontologies - description: Returns objects where the query is not satisfied. + AsyncApplyActionRequest: properties: - value: - $ref: "#/components/schemas/SearchJsonQueryV2" - required: - - value - StartsWithQuery: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - description: Returns objects where the specified field starts with the provided value. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string - x-safety: unsafe - required: - - field - - value - ContainsAllTermsInOrderQuery: + ApplyActionResponse: type: object x-namespace: Ontologies - description: | - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string - x-safety: unsafe - required: - - field - - value - ContainsAllTermsInOrderPrefixLastTerm: + BatchApplyActionResponse: type: object x-namespace: Ontologies - 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.\n" + QueryType: + description: Represents a query type in the Ontology. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: + apiName: + $ref: "#/components/schemas/QueryApiName" + description: type: string x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + parameters: + additionalProperties: + $ref: "#/components/schemas/Parameter" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + output: + $ref: "#/components/schemas/OntologyDataType" + rid: + $ref: "#/components/schemas/FunctionRid" + version: + $ref: "#/components/schemas/FunctionVersion" required: - - field - - value - ContainsAnyTermQuery: + - apiName + - rid + - version type: object x-namespace: Ontologies - 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" + QueryApiName: + description: | + The name of the Query in the API. + type: string + x-safety: unsafe + x-namespace: Ontologies + ExecuteQueryRequest: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/FuzzyV2" - required: - - field - - value - CenterPointTypes: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - Point: "#/components/schemas/GeoPoint" - oneOf: - - $ref: "#/components/schemas/GeoPoint" - WithinBoundingBoxPoint: + Attachment: type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - Point: "#/components/schemas/GeoPoint" - oneOf: - - $ref: "#/components/schemas/GeoPoint" - CenterPoint: + description: The representation of an attachment. + properties: + rid: + $ref: "#/components/schemas/AttachmentRid" + filename: + $ref: "#/components/schemas/Filename" + sizeBytes: + $ref: "#/components/schemas/SizeBytes" + mediaType: + $ref: "#/components/schemas/MediaType" + required: + - rid + - filename + - sizeBytes + - mediaType + AttachmentProperty: type: object x-namespace: Ontologies - description: | - The coordinate point to use as the center of the distance query. + description: The representation of an attachment as a data type. properties: - center: - $ref: "#/components/schemas/CenterPointTypes" - distance: - $ref: "#/components/schemas/Distance" + rid: + $ref: "#/components/schemas/AttachmentRid" required: - - center - - distance - WithinDistanceOfQuery: + - rid + AttachmentRid: + description: The unique resource identifier of an attachment. + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + ActionRid: + description: The unique resource identifier for an action. + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + AsyncApplyActionResponse: type: object x-namespace: Ontologies - description: | - Returns objects where the specified field contains a point within the distance provided of the center point. + AsyncActionOperation: + x-type: + type: asyncOperation + operationType: applyActionAsync + resultType: AsyncApplyActionResponse + stageType: AsyncActionStatus + x-namespace: Ontologies + AsyncActionStatus: + enum: + - RUNNING_SUBMISSION_CHECKS + - EXECUTING_WRITE_BACK_WEBHOOK + - COMPUTING_ONTOLOGY_EDITS + - COMPUTING_FUNCTION + - WRITING_ONTOLOGY_EDITS + - EXECUTING_SIDE_EFFECT_WEBHOOK + - SENDING_NOTIFICATIONS + x-namespace: Ontologies + QueryAggregation: + type: object properties: - field: - $ref: "#/components/schemas/PropertyApiName" + key: + x-safety: unsafe value: - $ref: "#/components/schemas/CenterPoint" + x-safety: unsafe required: - - field + - key - value - BoundingBoxValue: + NestedQueryAggregation: type: object - x-namespace: Ontologies - description: | - The top left and bottom right coordinate points that make up the bounding box. properties: - topLeft: - $ref: "#/components/schemas/WithinBoundingBoxPoint" - bottomRight: - $ref: "#/components/schemas/WithinBoundingBoxPoint" + key: + x-safety: unsafe + groups: + type: array + items: + $ref: "#/components/schemas/QueryAggregation" required: - - topLeft - - bottomRight - WithinBoundingBoxQuery: + - key + QueryAggregationRange: + description: Specifies a range from an inclusive start value to an exclusive end value. type: object x-namespace: Ontologies - description: | - Returns objects where the specified field contains a point within the bounding box provided. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/BoundingBoxValue" - required: - - field - - value - IntersectsBoundingBoxQuery: + startValue: + description: Inclusive start. + x-safety: unsafe + endValue: + description: Exclusive end. + x-safety: unsafe + QueryTwoDimensionalAggregation: type: object - x-namespace: Ontologies - description: | - Returns objects where the specified field intersects the bounding box provided. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/BoundingBoxValue" - required: - - field - - value - DoesNotIntersectBoundingBoxQuery: + groups: + type: array + items: + $ref: "#/components/schemas/QueryAggregation" + QueryThreeDimensionalAggregation: + type: object + properties: + groups: + type: array + items: + $ref: "#/components/schemas/NestedQueryAggregation" + ExecuteQueryResponse: type: object - x-namespace: Ontologies - description: | - Returns objects where the specified field does not intersect the bounding box provided. properties: - field: - $ref: "#/components/schemas/PropertyApiName" value: - $ref: "#/components/schemas/BoundingBoxValue" + $ref: "#/components/schemas/DataValue" required: - - field - value - PolygonValue: - type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - Polygon: "#/components/schemas/Polygon" - oneOf: - - $ref: "#/components/schemas/Polygon" - WithinPolygonQuery: - type: object + FilterValue: + description: | + Represents the value of a property filter. For instance, false is the FilterValue in + `properties.{propertyApiName}.isNull=false`. + type: string x-namespace: Ontologies + x-safety: unsafe + FunctionRid: description: | - Returns objects where the specified field contains a point within the polygon provided. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PolygonValue" - required: - - field - - value - IntersectsPolygonQuery: - type: object + The unique resource identifier of a Function, useful for interacting with other Foundry APIs. + format: rid + type: string x-namespace: Ontologies + x-safety: safe + FunctionVersion: description: | - Returns objects where the specified field intersects the polygon provided. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PolygonValue" - required: - - field - - value - DoesNotIntersectPolygonQuery: - type: object + The version of the given Function, written `..-`, where `-` is optional. + Examples: `1.2.3`, `1.2.3-rc1`. + type: string x-namespace: Ontologies + x-safety: unsafe + CustomTypeId: description: | - Returns objects where the specified field does not intersect the polygon provided. + A UUID representing a custom type in a given Function. + type: string + x-namespace: Ontologies + x-safety: safe + LinkTypeApiName: + description: | + The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** + application. + type: string + x-namespace: Ontologies + x-safety: unsafe + ListActionTypesResponse: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PolygonValue" - required: - - field - - value - ContainsAllTermsQuery: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/ActionType" + type: array type: object x-namespace: Ontologies - description: | - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. + ListQueryTypesResponse: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/FuzzyV2" - required: - - field - - value - FuzzyV2: - description: Setting fuzzy to `true` allows approximate matching in search queries that support it. - type: boolean + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/QueryType" + type: array + type: object x-namespace: Ontologies - x-safety: safe - SearchOrderByV2: - description: Specifies the ordering of search results by a field and an ordering direction. + ListLinkedObjectsResponse: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/OntologyObject" + type: array type: object x-namespace: Ontologies + ListObjectTypesResponse: properties: - fields: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of object types in the current page. items: - $ref: "#/components/schemas/SearchOrderingV2" + $ref: "#/components/schemas/ObjectType" type: array - SearchOrderingV2: type: object x-namespace: Ontologies + ListObjectsResponse: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - direction: - description: Specifies the ordering direction (can be either `asc` or `desc`) - type: string - x-safety: safe + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of objects in the current page. + items: + $ref: "#/components/schemas/OntologyObject" + type: array + totalCount: + $ref: "#/components/schemas/TotalCount" required: - - field - AnyType: - type: object - AttachmentType: - type: object - BinaryType: - type: object - BooleanType: - type: object - ByteType: - type: object - DateType: - type: object - DecimalType: + - totalCount type: object + x-namespace: Ontologies + ListOntologiesResponse: properties: - precision: - type: integer - x-safety: safe - scale: - type: integer - x-safety: safe - DoubleType: - type: object - FilesystemResource: - type: object - FloatType: - type: object - GeoShapeType: - type: object - GeoPointType: - type: object - IntegerType: - type: object - LocalFilePath: - type: object - LongType: - type: object - MarkingType: - type: object - ShortType: - type: object - StringType: - type: object - TimeSeriesItemType: - description: | - A union of the types supported by time series properties. - discriminator: - propertyName: type - mapping: - double: "#/components/schemas/DoubleType" - string: "#/components/schemas/StringType" - oneOf: - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/StringType" - TimeseriesType: + data: + description: The list of Ontologies the user has access to. + items: + $ref: "#/components/schemas/Ontology" + type: array type: object + x-namespace: Ontologies + ListOutgoingLinkTypesResponse: properties: - itemType: - $ref: "#/components/schemas/TimeSeriesItemType" - required: - - itemType - TimestampType: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of link type sides in the current page. + items: + $ref: "#/components/schemas/LinkTypeSide" + type: array type: object - StructFieldName: + x-namespace: Ontologies + ObjectRid: description: | - The name of a field in a `Struct`. + The unique resource identifier of an object, useful for interacting with other Foundry APIs. + format: rid type: string - x-safety: unsafe - NullType: - type: object - UnsupportedType: - type: object + x-namespace: Ontologies + x-safety: safe + ObjectType: + description: Represents an object type in the Ontology. properties: - unsupportedType: + apiName: + $ref: "#/components/schemas/ObjectTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + description: + description: The description of the object type. type: string - x-safety: safe + x-safety: unsafe + visibility: + $ref: "#/components/schemas/ObjectTypeVisibility" + primaryKey: + description: The primary key of the object. This is a list of properties that can be used to uniquely identify the object. + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + properties: + description: A map of the properties of the object type. + additionalProperties: + $ref: "#/components/schemas/Property" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + rid: + $ref: "#/components/schemas/ObjectTypeRid" required: - - unsupportedType - ContentLength: - type: string - format: long - x-safety: safe - ContentType: - type: string - x-safety: safe - Duration: - type: string - description: An ISO 8601 formatted duration. - x-safety: unsafe - PageSize: - description: The page size to use for the endpoint. - type: integer - x-safety: safe - PageToken: + - apiName + - status + - rid + type: object + x-namespace: Ontologies + ObjectTypeApiName: description: | - The page token indicates where to start paging. This should be omitted from the first page's request. - To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response - and populate the next request's `pageToken` field with it. + The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the + `List object types` endpoint or check the **Ontology Manager**. type: string + x-namespace: Ontologies x-safety: unsafe - TotalCount: - description: | - The total number of items across all pages. - type: string - format: long - x-safety: safe - PreviewMode: - description: Enables the use of preview functionality. - type: boolean - x-safety: safe - SizeBytes: - description: The size of the file or attachment in bytes. - type: string - format: long - x-safety: safe - UserId: - description: | - A Foundry User ID. - format: uuid + ObjectTypeVisibility: + enum: + - NORMAL + - PROMINENT + - HIDDEN + description: The suggested visibility of the object type. type: string - x-safety: safe - CreatedTime: - description: | - The time at which the resource was created. + x-namespace: Ontologies + ObjectTypeRid: + description: "The unique resource identifier of an object type, useful for interacting with other Foundry APIs." + format: rid type: string + x-namespace: Ontologies x-safety: safe - UpdatedTime: + Ontology: + description: Metadata about an Ontology. + properties: + apiName: + $ref: "#/components/schemas/OntologyApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + description: + type: string + x-safety: unsafe + rid: + $ref: "#/components/schemas/OntologyRid" + required: + - apiName + - displayName + - description + - rid + type: object + x-namespace: Ontologies + OntologyObject: + description: Represents an object in the Ontology. + properties: + properties: + description: A map of the property values of the object. + nullable: true + additionalProperties: + $ref: "#/components/schemas/PropertyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + rid: + $ref: "#/components/schemas/ObjectRid" + required: + - rid + type: object + x-namespace: Ontologies + OntologyRid: description: | - The time at which the resource was most recently updated. + The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the + `List ontologies` endpoint or check the **Ontology Manager**. + format: rid type: string + x-namespace: Ontologies x-safety: safe - FolderRid: + OntologyApiName: type: string - format: rid - x-safety: safe - FilePath: - description: | - The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. + x-namespace: Ontologies + x-safety: unsafe + OrderBy: + 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" type: string + x-namespace: Ontologies x-safety: unsafe - Filename: + Parameter: + description: Details about a parameter of an action or query. + properties: + description: + type: string + x-safety: unsafe + baseType: + $ref: "#/components/schemas/ValueType" + dataType: + $ref: "#/components/schemas/OntologyDataType" + required: + type: boolean + x-safety: safe + required: + - baseType + - required + type: object + x-namespace: Ontologies + ParameterId: description: | - The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. + The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. + Parameters can be viewed and managed in the **Ontology Manager**. type: string + x-namespace: Ontologies x-safety: unsafe - ArchiveFileFormat: + DataValue: description: | - The format of an archive file. - enum: - - ZIP - DisplayName: + Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. + | Type | JSON encoding | Example | + |-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| + | Array | array | `["alpha", "bravo", "charlie"]` | + | Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | + | Boolean | boolean | `true` | + | Byte | number | `31` | + | Date | ISO 8601 extended local date string | `"2021-05-01"` | + | Decimal | string | `"2.718281828"` | + | Float | number | `3.14159265` | + | Double | number | `3.14159265` | + | Integer | number | `238940` | + | Long | string | `"58319870951433"` | + | Marking | string | `"MU"` | + | Null | null | `null` | + | Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| + | Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | + | Set | array | `["alpha", "bravo", "charlie"]` | + | Short | number | `8739` | + | String | string | `"Call me Ishmael"` | + | Struct | JSON object | `{"name": "John Doe", "age": 42}` | + | TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | + | ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| + | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + x-safety: unsafe + PrimaryKeyValue: + description: Represents the primary key value that is used as a unique identifier for an object. + x-safety: unsafe + x-namespace: Ontologies + Property: + description: Details about some property of an object. + properties: + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + baseType: + $ref: "#/components/schemas/ValueType" + required: + - baseType + type: object + x-namespace: Ontologies + PropertyApiName: + description: | + The name of the property in the API. To find the API name for your property, use the `Get object type` + endpoint or check the **Ontology Manager**. type: string - description: The display name of the entity. + x-namespace: Ontologies x-safety: unsafe - MediaType: + FieldNameV1: + description: "A reference to an Ontology object property with the form `properties.{propertyApiName}`." + type: string + x-namespace: Ontologies + x-safety: unsafe + PropertyFilter: description: | - The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. - Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` + Represents a filter used on properties. + + Endpoints that accept this supports optional parameters that have the form: + `properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. + For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called + "firstName" that has the exact value of "John". + + The following are a list of supported property filters: + + - `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties + that have at least one of the provided values. If multiple query parameters are provided, then objects + that have any of the given values for the specified property will be matched. + - `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided + property. If multiple query parameters are provided, then objects that have any of the given values + will be matched. For instance, if the user provides a request by doing + `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property + of either John or Anna will be matched. This filter is supported on all property types except Arrays. + - `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. + Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values + will be excluded from the result. + - `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` + `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater + than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. + - `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. + This filter is supported on all property types. type: string + x-namespace: Ontologies x-safety: safe - ReleaseStatus: - enum: - - ACTIVE - - EXPERIMENTAL - - DEPRECATED - description: The release status of the entity. - TimeUnit: + PropertyId: + description: | + The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** + application and assign them API names. In every other case, API names should be used instead of property IDs. + type: string + x-namespace: Ontologies + x-safety: unsafe + SelectedPropertyApiName: + description: | + By default, anytime an object is requested, every property belonging to that object is returned. + The response can be filtered to only include certain properties using the `properties` query parameter. + + Properties to include can be specified in one of two ways. + + - A comma delimited list as the value for the `properties` query parameter + `properties={property1ApiName},{property2ApiName}` + - Multiple `properties` query parameters. + `properties={property1ApiName}&properties={property2ApiName}` + + The primary key of the object will always be returned even if it wasn't specified in the `properties` values. + + Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. + + To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. + type: string + x-namespace: Ontologies + x-safety: unsafe + PropertyValue: + description: | + Represents the value of a property in the following format. + + | Type | JSON encoding | Example | + |----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| + | Array | array | `["alpha", "bravo", "charlie"]` | + | Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | + | Boolean | boolean | `true` | + | Byte | number | `31` | + | Date | ISO 8601 extended local date string | `"2021-05-01"` | + | Decimal | string | `"2.718281828"` | + | Double | number | `3.14159265` | + | Float | number | `3.14159265` | + | GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | + | GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | + | Integer | number | `238940` | + | Long | string | `"58319870951433"` | + | Short | number | `8739` | + | String | string | `"Call me Ishmael"` | + | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + + Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. + x-safety: unsafe + x-namespace: Ontologies + PropertyValueEscapedString: + description: Represents the value of a property in string format. This is used in URL parameters. + type: string + x-namespace: Ontologies + x-safety: unsafe + LinkTypeSide: + type: object + x-namespace: Ontologies + properties: + apiName: + $ref: "#/components/schemas/LinkTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + cardinality: + $ref: "#/components/schemas/LinkTypeSideCardinality" + foreignKeyPropertyApiName: + $ref: "#/components/schemas/PropertyApiName" + required: + - apiName + - displayName + - status + - objectTypeApiName + - cardinality + LinkTypeSideCardinality: enum: - - MILLISECONDS - - SECONDS - - MINUTES - - HOURS - - DAYS - - WEEKS - - MONTHS - - YEARS - - QUARTERS - Distance: + - ONE + - MANY + x-namespace: Ontologies + AggregateObjectsRequest: type: object - description: A measurement of distance. + x-namespace: Ontologies properties: + aggregation: + items: + $ref: "#/components/schemas/Aggregation" + type: array + query: + $ref: "#/components/schemas/SearchJsonQuery" + groupBy: + items: + $ref: "#/components/schemas/AggregationGroupBy" + type: array + AggregateObjectsResponse: + properties: + excludedItems: + type: integer + x-safety: unsafe + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/AggregateObjectsResponseItem" + type: array + type: object + x-namespace: Ontologies + AggregateObjectsResponseItem: + type: object + x-namespace: Ontologies + properties: + group: + additionalProperties: + $ref: "#/components/schemas/AggregationGroupValue" + x-mapKey: + $ref: "#/components/schemas/AggregationGroupKey" + metrics: + items: + $ref: "#/components/schemas/AggregationMetricResult" + type: array + AggregationGroupKey: + type: string + x-namespace: Ontologies + x-safety: unsafe + AggregationGroupValue: + x-safety: unsafe + x-namespace: Ontologies + AggregationMetricResult: + type: object + x-namespace: Ontologies + properties: + name: + type: string + x-safety: unsafe value: type: number format: double + description: TBD x-safety: unsafe - unit: - $ref: "#/components/schemas/DistanceUnit" required: - - value - - unit - DistanceUnit: - enum: - - MILLIMETERS - - CENTIMETERS - - METERS - - KILOMETERS - - INCHES - - FEET - - YARDS - - MILES - - NAUTICAL_MILES - ApiFeaturePreviewUsageOnly: - description: | - This feature is only supported in preview mode. Please use `preview=true` in the query - parameters to call this endpoint. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - ApiUsageDenied: - description: You are not allowed to use Palantir APIs. - properties: - parameters: - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - InvalidPageSize: - description: The provided page size was zero or negative. Page sizes must be greater than zero. + - name + SearchObjectsRequest: properties: - parameters: - properties: - pageSize: - $ref: "#/components/schemas/PageSize" - required: - - pageSize - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - InvalidPageToken: - description: The provided page token could not be used to retrieve the next page of results. + query: + $ref: "#/components/schemas/SearchJsonQuery" + orderBy: + $ref: "#/components/schemas/SearchOrderBy" + pageSize: + $ref: "#/components/schemas/PageSize" + pageToken: + $ref: "#/components/schemas/PageToken" + fields: + description: | + The API names of the object type properties to include in the response. + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + required: + - query + type: object + x-namespace: Ontologies + SearchObjectsResponse: properties: - parameters: - properties: - pageToken: - $ref: "#/components/schemas/PageToken" - required: - - pageToken - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - InvalidParameterCombination: - description: The given parameters are individually valid but cannot be used in the given combination. + data: + items: + $ref: "#/components/schemas/OntologyObject" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount + type: object + x-namespace: Ontologies + ValidateActionRequest: properties: parameters: - properties: - validCombinations: - type: array - items: - type: array - items: - type: string - x-safety: safe - providedParameters: - type: array - items: - type: string - x-safety: safe - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - ResourceNameAlreadyExists: - description: The provided resource name is already in use by another resource in the same folder. + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + type: object + x-namespace: Ontologies + ValidateActionResponse: + type: object + x-namespace: Ontologies properties: + result: + $ref: "#/components/schemas/ValidationResult" + submissionCriteria: + items: + $ref: "#/components/schemas/SubmissionCriteriaEvaluation" + type: array parameters: - properties: - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - resourceName: - type: string - x-safety: unsafe - required: - - parentFolderRid - - resourceName - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - FolderNotFound: - description: "The requested folder could not be found, or the client token does not have access to it." + additionalProperties: + $ref: "#/components/schemas/ParameterEvaluationResult" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + required: + - result + SubmissionCriteriaEvaluation: + description: | + Contains the status of the **submission criteria**. + **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. + These are configured in the **Ontology Manager**. + type: object + x-namespace: Ontologies properties: - parameters: - properties: - folderRid: - $ref: "#/components/schemas/FolderRid" - required: - - folderRid - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: + configuredFailureMessage: + description: | + The message indicating one of the **submission criteria** was not satisfied. + This is configured per **submission criteria** in the **Ontology Manager**. type: string - x-type: error - MissingPostBody: - description: "A post body is required for this endpoint, but was not found in the request." + x-safety: unsafe + result: + $ref: "#/components/schemas/ValidationResult" + required: + - result + ValidationResult: + description: | + Represents the state of a validation. + enum: + - VALID + - INVALID + type: string + x-namespace: Ontologies + ResourcePath: + description: | + A path in the Foundry file tree. + type: string + x-safety: unsafe + x-namespace: Datasets + DatasetName: + type: string + x-safety: unsafe + x-namespace: Datasets + DatasetRid: + description: | + The Resource Identifier (RID) of a Dataset. Example: `ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`. + format: rid + type: string + x-safety: safe + Dataset: properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - UnknownDistanceUnit: - description: An unknown distance unit was provided. + rid: + $ref: "#/components/schemas/DatasetRid" + name: + $ref: "#/components/schemas/DatasetName" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + required: + - rid + - name + - parentFolderRid + type: object + x-namespace: Datasets + CreateDatasetRequest: + properties: + name: + $ref: "#/components/schemas/DatasetName" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + required: + - name + - parentFolderRid + type: object + x-namespace: Datasets + TableExportFormat: + description: | + Format for tabular dataset export. + enum: + - ARROW + - CSV + x-namespace: Datasets + BranchId: + description: | + The identifier (name) of a Branch. Example: `master`. + type: string + x-safety: unsafe + Branch: + description: | + A Branch of a Dataset. + properties: + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - branchId + type: object + x-namespace: Datasets + CreateBranchRequest: + properties: + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - branchId + type: object + x-namespace: Datasets + ListBranchesResponse: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of branches in the current page. + items: + $ref: "#/components/schemas/Branch" + type: array + type: object + x-namespace: Datasets + TransactionRid: + description: | + The Resource Identifier (RID) of a Transaction. Example: `ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4`. + format: rid + type: string + x-safety: safe + x-namespace: Datasets + TransactionType: + description: | + The type of a Transaction. + enum: + - APPEND + - UPDATE + - SNAPSHOT + - DELETE + x-namespace: Datasets + TransactionStatus: + description: | + The status of a Transaction. + enum: + - ABORTED + - COMMITTED + - OPEN + x-namespace: Datasets + CreateTransactionRequest: + properties: + transactionType: + $ref: "#/components/schemas/TransactionType" + type: object + x-namespace: Datasets + Transaction: + description: | + An operation that modifies the files within a dataset. + properties: + rid: + $ref: "#/components/schemas/TransactionRid" + transactionType: + $ref: "#/components/schemas/TransactionType" + status: + $ref: "#/components/schemas/TransactionStatus" + createdTime: + type: string + format: date-time + description: "The timestamp when the transaction was created, in ISO 8601 timestamp format." + x-safety: unsafe + closedTime: + type: string + format: date-time + description: "The timestamp when the transaction was closed, in ISO 8601 timestamp format." + x-safety: unsafe + required: + - rid + - transactionType + - status + - createdTime + type: object + x-namespace: Datasets + File: + properties: + path: + $ref: "#/components/schemas/FilePath" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + sizeBytes: + type: string + format: long + x-safety: safe + updatedTime: + type: string + format: date-time + x-safety: unsafe + required: + - path + - transactionRid + - updatedTime + type: object + x-namespace: Datasets + ListFilesResponse: + description: A page of Files and an optional page token that can be used to retrieve the next page. + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/File" + type: array + type: object + x-namespace: Datasets + OperationNotFound: + description: "The operation is not found, or the user does not have access to it." properties: parameters: type: object properties: - unknownUnit: + id: type: string - x-safety: unsafe - knownUnits: - type: array - items: - $ref: "#/components/schemas/DistanceUnit" + format: rid + x-safety: safe required: - - unknownUnit + - id errorCode: enum: - INVALID_ARGUMENT @@ -3169,47 +3612,62 @@ components: errorInstanceId: type: string x-type: error - LanguageModelSourceNotSupported: - x-type: error - x-namespace: Models + x-namespace: Operations + DatasetNotFound: + description: "The requested dataset could not be found, or the client token does not have access to it." properties: parameters: properties: - source: - $ref: "#/components/schemas/LanguageModelSource" + datasetRid: + $ref: "#/components/schemas/DatasetRid" required: - - source + - datasetRid type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string - ActionEditedPropertiesNotFound: - description: | - Actions attempted to edit properties that could not be found on the object type. - Please contact the Ontology administrator to resolve this issue. + x-type: error + x-namespace: Datasets + CreateDatasetPermissionDenied: + description: The provided token does not have permission to create a dataset in this folder. properties: parameters: + properties: + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + name: + $ref: "#/components/schemas/DatasetName" + required: + - parentFolderRid + - name type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ObjectAlreadyExists: - description: | - The object the user is attempting to create already exists. + x-namespace: Datasets + BranchAlreadyExists: + description: The branch cannot be created because a branch with that name already exists. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + required: + - datasetRid + - branchId type: object errorCode: enum: @@ -3220,50 +3678,62 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - LinkAlreadyExists: - description: | - The link the user is attempting to create already exists. + x-namespace: Datasets + InvalidBranchId: + description: The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. properties: parameters: + properties: + branchId: + $ref: "#/components/schemas/BranchId" + required: + - branchId type: object errorCode: enum: - - CONFLICT + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - FunctionExecutionFailed: - x-type: error - x-namespace: Ontologies + x-namespace: Datasets + BranchNotFound: + description: "The requested branch could not be found, or the client token does not have access to it." properties: parameters: properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" required: - - functionRid - - functionVersion + - datasetRid + - branchId type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string - ParentAttachmentPermissionDenied: - description: | - The user does not have permission to parent attachments. + x-type: error + x-namespace: Datasets + CreateBranchPermissionDenied: + description: The provided token does not have permission to create a branch of this dataset. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + required: + - datasetRid + - branchId type: object errorCode: enum: @@ -3274,13 +3744,20 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - EditObjectPermissionDenied: - description: | - The user does not have permission to edit this `ObjectType`. + x-namespace: Datasets + DeleteBranchPermissionDenied: + description: The provided token does not have permission to delete the given branch from this dataset. properties: parameters: - type: object + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + required: + - datasetRid + - branchId + type: object errorCode: enum: - PERMISSION_DENIED @@ -3290,19 +3767,20 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ViewObjectPermissionDenied: - description: | - The provided token does not have permission to view any data sources backing this object type. Ensure the object - type has backing data sources configured and visible. + x-namespace: Datasets + CreateTransactionPermissionDenied: + description: The provided token does not have permission to create a transaction on this dataset. properties: parameters: - type: object properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" required: - - objectType + - datasetRid + - branchId + type: object errorCode: enum: - PERMISSION_DENIED @@ -3312,12 +3790,19 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ObjectChanged: - description: | - An object used by this `Action` was changed by someone else while the `Action` was running. + x-namespace: Datasets + OpenTransactionAlreadyExists: + description: A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + required: + - datasetRid + - branchId type: object errorCode: enum: @@ -3328,58 +3813,71 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ActionParameterObjectTypeNotFound: - description: | - The parameter references an object type that could not be found, or the client token does not have access to it. + x-namespace: Datasets + TransactionNotOpen: + description: The given transaction is not open. properties: parameters: - type: object properties: - parameterId: - $ref: "#/components/schemas/ParameterId" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + transactionStatus: + $ref: "#/components/schemas/TransactionStatus" required: - - parameterId + - datasetRid + - transactionRid + - transactionStatus + type: object errorCode: enum: - - NOT_FOUND + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ActionParameterObjectNotFound: - description: | - The parameter object reference or parameter default value is not found, or the client token does not have access to it. + x-namespace: Datasets + TransactionNotCommitted: + description: The given transaction has not been committed. properties: parameters: - type: object properties: - parameterId: - $ref: "#/components/schemas/ParameterId" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + transactionStatus: + $ref: "#/components/schemas/TransactionStatus" required: - - parameterId + - datasetRid + - transactionRid + - transactionStatus + type: object errorCode: enum: - - NOT_FOUND + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ActionNotFound: - description: "The action is not found, or the user does not have access to it." + x-namespace: Datasets + TransactionNotFound: + description: "The requested transaction could not be found on the dataset, or the client token does not have access to it." properties: parameters: properties: - actionRid: - $ref: "#/components/schemas/ActionRid" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - - actionRid + - datasetRid + - transactionRid type: object errorCode: enum: @@ -3390,52 +3888,68 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ActionTypeNotFound: - description: "The action type is not found, or the user does not have access to it." + x-namespace: Datasets + CommitTransactionPermissionDenied: + description: The provided token does not have permission to commit the given transaction on the given dataset. properties: parameters: properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - rid: - $ref: "#/components/schemas/ActionTypeRid" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - datasetRid + - transactionRid type: object errorCode: enum: - - NOT_FOUND + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ActionValidationFailed: - description: | - The validation failed for the given action parameters. Please use the `validateAction` endpoint for more - details. + x-namespace: Datasets + AbortTransactionPermissionDenied: + description: The provided token does not have permission to abort the given transaction on the given dataset. properties: parameters: properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - - actionType + - datasetRid + - transactionRid type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ApplyActionFailed: + x-namespace: Datasets + InvalidTransactionType: + description: "The given transaction type is not valid. Valid transaction types are `SNAPSHOT`, `UPDATE`, `APPEND`, and `DELETE`." properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + transactionType: + $ref: "#/components/schemas/TransactionType" + required: + - datasetRid + - transactionRid + - transactionType type: object errorCode: enum: @@ -3446,192 +3960,214 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - AttachmentNotFound: - 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" + x-namespace: Datasets + UploadFilePermissionDenied: + description: The provided token does not have permission to upload the given file to the given dataset and transaction. properties: parameters: - type: object properties: - attachmentRid: - $ref: "#/components/schemas/AttachmentRid" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + path: + $ref: "#/components/schemas/FilePath" + required: + - datasetRid + - transactionRid + - path + type: object errorCode: enum: - - NOT_FOUND + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - AttachmentSizeExceededLimit: - description: | - The file is too large to be uploaded as an attachment. - The maximum attachment size is 200MB. + x-namespace: Datasets + FileNotFoundOnBranch: + description: "The requested file could not be found on the given branch, or the client token does not have access to it." properties: parameters: - type: object properties: - fileSizeBytes: - type: string - x-safety: unsafe - fileLimitBytes: - type: string - x-safety: safe + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + path: + $ref: "#/components/schemas/FilePath" required: - - fileSizeBytes - - fileLimitBytes + - datasetRid + - branchId + - path + type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - DuplicateOrderBy: - description: The requested sort order includes duplicate properties. + x-namespace: Datasets + FileNotFoundOnTransactionRange: + description: "The requested file could not be found on the given transaction range, or the client token does not have access to it." properties: parameters: properties: - properties: - type: array - items: - $ref: "#/components/schemas/PropertyApiName" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + startTransactionRid: + $ref: "#/components/schemas/TransactionRid" + endTransactionRid: + $ref: "#/components/schemas/TransactionRid" + path: + $ref: "#/components/schemas/FilePath" + required: + - datasetRid + - endTransactionRid + - path type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - FunctionInvalidInput: - x-type: error - x-namespace: Ontologies + FileAlreadyExists: + description: The given file path already exists in the dataset and transaction. properties: parameters: properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + path: + $ref: "#/components/schemas/FilePath" required: - - functionRid - - functionVersion + - datasetRid + - transactionRid + - path type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string - FunctionExecutionTimedOut: x-type: error - x-namespace: Ontologies + x-namespace: Datasets + SchemaNotFound: + description: "A schema could not be found for the given dataset and branch, or the client token does not have access to it." properties: parameters: properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - - functionRid - - functionVersion + - datasetRid + - branchId type: object errorCode: enum: - - TIMEOUT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string - CompositePrimaryKeyNotSupported: - description: | - Primary keys consisting of multiple properties are not supported by this API. If you need support for this, - please reach out to Palantir Support. + x-type: error + x-namespace: Datasets + PutSchemaPermissionDenied: + description: todo properties: parameters: properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" required: - - objectType + - datasetRid + - branchId type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidContentLength: - description: "A `Content-Length` header is required for all uploads, but was missing or invalid." + x-namespace: Datasets + DeleteSchemaPermissionDenied: + description: todo properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - datasetRid + - branchId type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidContentType: - description: | - The `Content-Type` cannot be inferred from the request content and filename. - Please check your request content and filename to ensure they are compatible. + x-namespace: Datasets + ReadTablePermissionDenied: + description: The provided token does not have permission to read the given dataset as a table. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + required: + - datasetRid type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - FunctionEncounteredUserFacingError: - description: | - The authored function failed to execute because of a user induced error. The message argument - is meant to be displayed to the user. + x-namespace: Datasets + DatasetReadNotSupported: + description: The dataset does not support being read. properties: parameters: properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - message: - type: string - x-safety: unsafe + datasetRid: + $ref: "#/components/schemas/DatasetRid" required: - - functionRid - - functionVersion - - message + - datasetRid type: object errorCode: enum: @@ -3642,17 +4178,16 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidGroupId: - description: The provided value for a group id must be a UUID. + x-namespace: Datasets + ColumnTypesNotSupported: + description: The dataset contains column types that are not supported. properties: parameters: properties: - groupId: - type: string - x-safety: unsafe + datasetRid: + $ref: "#/components/schemas/DatasetRid" required: - - groupId + - datasetRid type: object errorCode: enum: @@ -3663,17 +4198,12 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidUserId: - description: The provided value for a user id must be a UUID. + x-namespace: Datasets + InvalidAggregationRange: + description: | + Aggregation range should include one lt or lte and one gt or gte. properties: parameters: - properties: - userId: - type: string - x-safety: unsafe - required: - - userId type: object errorCode: enum: @@ -3685,23 +4215,23 @@ components: type: string x-type: error x-namespace: Ontologies - AggregationGroupCountExceededLimit: + InvalidAggregationRangePropertyType: description: | - The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by - adjusting your query to reduce the number of groups created by your aggregation. For instance: - - If you are using multiple `groupBy` clauses, try reducing the number of clauses. - - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first - to reduce the number of groups. + Range group by is not supported by property type. properties: parameters: - properties: - groupsCount: - type: integer - x-safety: safe - groupsLimit: - type: integer - x-safety: safe type: object + properties: + property: + $ref: "#/components/schemas/PropertyApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" + required: + - property + - objectType + - propertyBaseType errorCode: enum: - INVALID_ARGUMENT @@ -3712,26 +4242,23 @@ components: type: string x-type: error x-namespace: Ontologies - AggregationMemoryExceededLimit: + InvalidAggregationRangeValue: description: | - The amount of memory used in the request exceeded the limit. The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by - adjusting your query to reduce the number of groups created by your aggregation. For instance: - - If you are using multiple `groupBy` clauses, try reducing the number of clauses. - - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first - to reduce the number of groups. + Aggregation value does not conform to the expected underlying type. properties: parameters: - properties: - memoryUsedBytes: - type: string - x-safety: safe - memoryLimitBytes: - type: string - x-safety: safe type: object + properties: + property: + $ref: "#/components/schemas/PropertyApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" required: - - memoryUsedBytes - - memoryLimitBytes + - property + - objectType + - propertyBaseType errorCode: enum: - INVALID_ARGUMENT @@ -3742,24 +4269,23 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidParameterValue: + InvalidDurationGroupByPropertyType: description: | - The value of the given parameter is invalid. See the documentation of `DataValue` for details on - how parameters are represented. + Invalid property type for duration groupBy. properties: parameters: + type: object properties: - parameterBaseType: + property: + $ref: "#/components/schemas/PropertyApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + propertyBaseType: $ref: "#/components/schemas/ValueType" - parameterDataType: - $ref: "#/components/schemas/OntologyDataType" - parameterId: - $ref: "#/components/schemas/ParameterId" - parameterValue: - $ref: "#/components/schemas/DataValue" required: - - parameterId - type: object + - property + - objectType + - propertyBaseType errorCode: enum: - INVALID_ARGUMENT @@ -3770,22 +4296,13 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidQueryParameterValue: + InvalidDurationGroupByValue: description: | - The value of the given parameter is invalid. See the documentation of `DataValue` for details on - how parameters are represented. + Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support + filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by + every two hours are allowed. properties: parameters: - properties: - parameterDataType: - $ref: "#/components/schemas/QueryDataType" - parameterId: - $ref: "#/components/schemas/ParameterId" - parameterValue: - $ref: "#/components/schemas/DataValue" - required: - - parameterId - - parameterDataType type: object errorCode: enum: @@ -3797,19 +4314,18 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidFields: + MultipleGroupByOnFieldNotSupported: description: | - The value of the given field does not match the expected pattern. For example, an Ontology object property `id` - should be written `properties.id`. + Aggregation cannot group by on the same field multiple times. properties: parameters: + type: object properties: - properties: + duplicateFields: items: type: string x-safety: unsafe type: array - type: object errorCode: enum: - INVALID_ARGUMENT @@ -3820,26 +4336,11 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidPropertyFilterValue: + InvalidAggregationOrdering: description: | - The value of the given property filter is invalid. For instance, 2 is an invalid value for - `isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type. + Aggregation ordering can only be applied to metrics with exactly one groupBy clause. properties: parameters: - properties: - expectedType: - $ref: "#/components/schemas/ValueType" - propertyFilter: - $ref: "#/components/schemas/PropertyFilter" - propertyFilterValue: - $ref: "#/components/schemas/FilterValue" - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - expectedType - - property - - propertyFilter - - propertyFilterValue type: object errorCode: enum: @@ -3851,19 +4352,12 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidPropertyFiltersCombination: - description: The provided filters cannot be used together. + ApiFeaturePreviewUsageOnly: + description: | + This feature is only supported in preview mode. Please use `preview=true` in the query + parameters to call this endpoint. properties: parameters: - properties: - propertyFilters: - items: - $ref: "#/components/schemas/PropertyFilter" - type: array - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - property type: object errorCode: enum: @@ -3874,48 +4368,29 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidPropertyValue: - description: | - The value of the given property is invalid. See the documentation of `PropertyValue` for details on - how properties are represented. + ApiUsageDenied: + description: You are not allowed to use Palantir APIs. properties: parameters: - properties: - propertyBaseType: - $ref: "#/components/schemas/ValueType" - property: - $ref: "#/components/schemas/PropertyApiName" - propertyValue: - $ref: "#/components/schemas/PropertyValue" - required: - - property - - propertyBaseType - - propertyValue type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidPropertyType: - description: | - The given property type is not of the expected type. + InvalidPageSize: + description: The provided page size was zero or negative. Page sizes must be greater than zero. properties: parameters: properties: - propertyBaseType: - $ref: "#/components/schemas/ValueType" - property: - $ref: "#/components/schemas/PropertyApiName" + pageSize: + $ref: "#/components/schemas/PageSize" required: - - property - - propertyBaseType + - pageSize type: object errorCode: enum: @@ -3926,19 +4401,15 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidSortOrder: - description: | - The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort - order can also be omitted, and defaults to 'asc'. + InvalidPageToken: + description: The provided page token could not be used to retrieve the next page of results. properties: parameters: properties: - invalidSortOrder: - type: string - x-safety: unsafe + pageToken: + $ref: "#/components/schemas/PageToken" required: - - invalidSortOrder + - pageToken type: object errorCode: enum: @@ -3949,17 +4420,23 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidSortType: - description: The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'. + InvalidParameterCombination: + description: The given parameters are individually valid but cannot be used in the given combination. properties: parameters: properties: - invalidSortType: - type: string - x-safety: safe - required: - - invalidSortType + validCombinations: + type: array + items: + type: array + items: + type: string + x-safety: safe + providedParameters: + type: array + items: + type: string + x-safety: safe type: object errorCode: enum: @@ -3970,47 +4447,38 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - LinkTypeNotFound: - description: "The link type is not found, or the user does not have access to it." + ResourceNameAlreadyExists: + description: The provided resource name is already in use by another resource in the same folder. properties: parameters: properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - linkType: - $ref: "#/components/schemas/LinkTypeApiName" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + resourceName: + type: string + x-safety: unsafe required: - - linkType - - objectType + - parentFolderRid + - resourceName type: object errorCode: enum: - - NOT_FOUND + - CONFLICT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - LinkedObjectNotFound: - description: "The linked object with the given primary key is not found, or the user does not have access to it." + FolderNotFound: + description: "The requested folder could not be found, or the client token does not have access to it." properties: parameters: properties: - linkType: - $ref: "#/components/schemas/LinkTypeApiName" - linkedObjectType: - $ref: "#/components/schemas/ObjectTypeApiName" - linkedObjectPrimaryKey: - additionalProperties: - $ref: "#/components/schemas/PrimaryKeyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" + folderRid: + $ref: "#/components/schemas/FolderRid" required: - - linkType - - linkedObjectType + - folderRid type: object errorCode: enum: @@ -4021,18 +4489,10 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - MalformedPropertyFilters: - description: | - At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`. + MissingPostBody: + description: "A post body is required for this endpoint, but was not found in the request." properties: parameters: - properties: - malformedPropertyFilter: - type: string - x-safety: unsafe - required: - - malformedPropertyFilter type: object errorCode: enum: @@ -4043,19 +4503,21 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - MissingParameter: - description: | - Required parameters are missing. Please look at the `parameters` field to see which required parameters are - missing from the request. + UnknownDistanceUnit: + description: An unknown distance unit was provided. properties: parameters: + type: object properties: - parameters: - items: - $ref: "#/components/schemas/ParameterId" + unknownUnit: + type: string + x-safety: unsafe + knownUnits: type: array - type: object + items: + $ref: "#/components/schemas/DistanceUnit" + required: + - unknownUnit errorCode: enum: - INVALID_ARGUMENT @@ -4065,4353 +4527,3234 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - MultiplePropertyValuesNotSupported: + AnyType: + type: object + AttachmentType: + type: object + BinaryType: + type: object + BooleanType: + type: object + ByteType: + type: object + DateType: + type: object + DecimalType: + type: object + properties: + precision: + type: integer + x-safety: safe + scale: + type: integer + x-safety: safe + DoubleType: + type: object + FilesystemResource: + type: object + FloatType: + type: object + GeoShapeType: + type: object + GeoPointType: + type: object + IntegerType: + type: object + LocalFilePath: + type: object + LongType: + type: object + MarkingType: + type: object + ShortType: + type: object + StringType: + type: object + TimeSeriesItemType: description: | - One of the requested property filters does not support multiple values. Please include only a single value for - it. + A union of the types supported by time series properties. + discriminator: + propertyName: type + mapping: + double: "#/components/schemas/DoubleType" + string: "#/components/schemas/StringType" + oneOf: + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/StringType" + TimeseriesType: + type: object properties: - parameters: - properties: - propertyFilter: - $ref: "#/components/schemas/PropertyFilter" - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - property - - propertyFilter - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectNotFound: - description: "The requested object is not found, or the client token does not have access to it." + itemType: + $ref: "#/components/schemas/TimeSeriesItemType" + required: + - itemType + TimestampType: + type: object + StructFieldName: + description: | + The name of a field in a `Struct`. + type: string + x-safety: unsafe + NullType: + type: object + UnsupportedType: + type: object properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - additionalProperties: - $ref: "#/components/schemas/PrimaryKeyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - type: object - errorCode: - enum: - - NOT_FOUND + unsupportedType: type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectTypeNotFound: - description: "The requested object type is not found, or the client token does not have access to it." - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - objectTypeRid: - $ref: "#/components/schemas/ObjectTypeRid" - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - UnsupportedObjectSet: - description: The requested object set is not supported. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectsExceededLimit: + x-safety: safe + required: + - unsupportedType + ContentLength: + type: string + format: long + x-safety: safe + ContentType: + type: string + x-safety: safe + Duration: + type: string + description: An ISO 8601 formatted duration. + x-safety: unsafe + PageSize: + description: The page size to use for the endpoint. + type: integer + x-safety: safe + PageToken: description: | - There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this - API for a given request. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - OntologyEditsExceededLimit: + The page token indicates where to start paging. This should be omitted from the first page's request. + To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response + and populate the next request's `pageToken` field with it. + type: string + x-safety: unsafe + TotalCount: description: | - The number of edits to the Ontology exceeded the allowed limit. - This may happen because of the request or because the Action is modifying too many objects. - Please change the size of your request or contact the Ontology administrator. - properties: - parameters: - properties: - editsCount: - type: integer - x-safety: unsafe - editsLimit: - type: integer - x-safety: unsafe - required: - - editsCount - - editsLimit - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - OntologyNotFound: - description: "The requested Ontology is not found, or the client token does not have access to it." - properties: - parameters: - properties: - ontologyRid: - $ref: "#/components/schemas/OntologyRid" - apiName: - $ref: "#/components/schemas/OntologyApiName" - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - OntologySyncing: + The total number of items across all pages. + type: string + format: long + x-safety: safe + PreviewMode: + description: Enables the use of preview functionality. + type: boolean + x-safety: safe + SizeBytes: + description: The size of the file or attachment in bytes. + type: string + format: long + x-safety: safe + UserId: description: | - The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a - few seconds and try again. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectType - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - OntologySyncingObjectTypes: + A Foundry User ID. + format: uuid + type: string + x-safety: safe + CreatedTime: description: | - One or more requested object types have been changed in the **Ontology Manager** and changes are currently being - applied. Wait a few seconds and try again. - properties: - parameters: - properties: - objectTypes: - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectTypeNotSynced: + The time at which the resource was created. + type: string + x-safety: safe + UpdatedTime: description: | - The requested object type is not synced into the ontology. Please reach out to your Ontology - Administrator to re-index the object type in Ontology Management Application. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectType - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectTypesNotSynced: + The time at which the resource was most recently updated. + type: string + x-safety: safe + FolderRid: + type: string + format: rid + x-safety: safe + FilePath: description: | - One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology - Administrator to re-index the object type(s) in Ontology Management Application. - properties: - parameters: - properties: - objectTypes: - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ParameterTypeNotSupported: + The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. + type: string + x-safety: unsafe + Filename: description: | - The type of the requested parameter is not currently supported by this API. If you need support for this, - please reach out to Palantir Support. - properties: - parameters: - properties: - parameterId: - $ref: "#/components/schemas/ParameterId" - parameterBaseType: - $ref: "#/components/schemas/ValueType" - required: - - parameterBaseType - - parameterId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ParametersNotFound: + The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. + type: string + x-safety: unsafe + ArchiveFileFormat: description: | - The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field - to see which ones are available. + The format of an archive file. + enum: + - ZIP + DisplayName: + type: string + description: The display name of the entity. + x-safety: unsafe + MediaType: + description: | + The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. + Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` + type: string + x-safety: safe + ReleaseStatus: + enum: + - ACTIVE + - EXPERIMENTAL + - DEPRECATED + description: The release status of the entity. + TimeUnit: + enum: + - MILLISECONDS + - SECONDS + - MINUTES + - HOURS + - DAYS + - WEEKS + - MONTHS + - YEARS + - QUARTERS + Distance: + type: object + description: A measurement of distance. properties: - parameters: - properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - unknownParameterIds: - items: - $ref: "#/components/schemas/ParameterId" - type: array - configuredParameterIds: - items: - $ref: "#/components/schemas/ParameterId" - type: array - required: - - actionType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + value: + type: number + format: double + x-safety: unsafe + unit: + $ref: "#/components/schemas/DistanceUnit" + required: + - value + - unit + DistanceUnit: + enum: + - MILLIMETERS + - CENTIMETERS + - METERS + - KILOMETERS + - INCHES + - FEET + - YARDS + - MILES + - NAUTICAL_MILES + SearchJsonQueryV2: + type: object x-namespace: Ontologies - PropertiesNotFound: - description: The requested properties are not found on the object type. + discriminator: + propertyName: type + mapping: + lt: "#/components/schemas/LtQueryV2" + gt: "#/components/schemas/GtQueryV2" + lte: "#/components/schemas/LteQueryV2" + gte: "#/components/schemas/GteQueryV2" + eq: "#/components/schemas/EqualsQueryV2" + isNull: "#/components/schemas/IsNullQueryV2" + contains: "#/components/schemas/ContainsQueryV2" + and: "#/components/schemas/AndQueryV2" + or: "#/components/schemas/OrQueryV2" + not: "#/components/schemas/NotQueryV2" + startsWith: "#/components/schemas/StartsWithQuery" + containsAllTermsInOrder: "#/components/schemas/ContainsAllTermsInOrderQuery" + containsAllTermsInOrderPrefixLastTerm: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" + containsAnyTerm: "#/components/schemas/ContainsAnyTermQuery" + containsAllTerms: "#/components/schemas/ContainsAllTermsQuery" + withinDistanceOf: "#/components/schemas/WithinDistanceOfQuery" + withinBoundingBox: "#/components/schemas/WithinBoundingBoxQuery" + intersectsBoundingBox: "#/components/schemas/IntersectsBoundingBoxQuery" + doesNotIntersectBoundingBox: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" + withinPolygon: "#/components/schemas/WithinPolygonQuery" + intersectsPolygon: "#/components/schemas/IntersectsPolygonQuery" + doesNotIntersectPolygon: "#/components/schemas/DoesNotIntersectPolygonQuery" + oneOf: + - $ref: "#/components/schemas/LtQueryV2" + - $ref: "#/components/schemas/GtQueryV2" + - $ref: "#/components/schemas/LteQueryV2" + - $ref: "#/components/schemas/GteQueryV2" + - $ref: "#/components/schemas/EqualsQueryV2" + - $ref: "#/components/schemas/IsNullQueryV2" + - $ref: "#/components/schemas/ContainsQueryV2" + - $ref: "#/components/schemas/AndQueryV2" + - $ref: "#/components/schemas/OrQueryV2" + - $ref: "#/components/schemas/NotQueryV2" + - $ref: "#/components/schemas/StartsWithQuery" + - $ref: "#/components/schemas/ContainsAllTermsInOrderQuery" + - $ref: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" + - $ref: "#/components/schemas/ContainsAnyTermQuery" + - $ref: "#/components/schemas/ContainsAllTermsQuery" + - $ref: "#/components/schemas/WithinDistanceOfQuery" + - $ref: "#/components/schemas/WithinBoundingBoxQuery" + - $ref: "#/components/schemas/IntersectsBoundingBoxQuery" + - $ref: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" + - $ref: "#/components/schemas/WithinPolygonQuery" + - $ref: "#/components/schemas/IntersectsPolygonQuery" + - $ref: "#/components/schemas/DoesNotIntersectPolygonQuery" + LtQueryV2: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is less than a value. properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - properties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - required: - - objectType - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + GtQueryV2: + type: object x-namespace: Ontologies - PropertiesNotSortable: - description: | - Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and - *Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay - between the time a property is set to *Searchable* and *Sortable* and when it can be used. + description: Returns objects where the specified field is greater than a value. properties: - parameters: - properties: - properties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + LteQueryV2: + type: object x-namespace: Ontologies - ParameterObjectNotFound: - description: | - The parameter object reference or parameter default value is not found, or the client token does not have access to it. + description: Returns objects where the specified field is less than or equal to a value. properties: - parameters: - type: object - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - additionalProperties: - $ref: "#/components/schemas/PrimaryKeyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - required: - - objectType - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + GteQueryV2: + type: object x-namespace: Ontologies - ParameterObjectSetRidNotFound: - description: | - The parameter object set RID is not found, or the client token does not have access to it. + description: Returns objects where the specified field is greater than or equal to a value. properties: - parameters: - type: object - properties: - objectSetRid: - type: string - format: rid - x-safety: safe - required: - - objectSetRid - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + EqualsQueryV2: + type: object x-namespace: Ontologies - PropertiesNotSearchable: - description: | - Search is not enabled on the specified properties. Please mark the properties as *Searchable* - in the **Ontology Manager** to enable search on them. There may be a short delay - between the time a property is marked *Searchable* and when it can be used. + description: Returns objects where the specified field is equal to a value. properties: - parameters: - properties: - propertyApiNames: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + IsNullQueryV2: + type: object x-namespace: Ontologies - PropertiesNotFilterable: - description: | - Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and - *Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay - between the time a property is marked *Searchable* and *Selectable* and when it can be used. + description: Returns objects based on the existence of the specified field. properties: - parameters: - properties: - properties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + type: boolean + x-safety: unsafe + required: + - field + - value + ContainsQueryV2: + type: object x-namespace: Ontologies - PropertyApiNameNotFound: - description: | - A property that was required to have an API name, such as a primary key, is missing one. You can set an API - name for it using the **Ontology Manager**. + description: Returns objects where the specified array contains a value. properties: - parameters: - properties: - propertyId: - $ref: "#/components/schemas/PropertyId" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - propertyBaseType - - propertyId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + AndQueryV2: + type: object x-namespace: Ontologies - PropertyBaseTypeNotSupported: - description: | - The type of the requested property is not currently supported by this API. If you need support for this, - please reach out to Palantir Support. + description: Returns objects where every query is satisfied. properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - property: - $ref: "#/components/schemas/PropertyApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - objectType - - property - - propertyBaseType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + value: + items: + $ref: "#/components/schemas/SearchJsonQueryV2" + type: array + OrQueryV2: + type: object x-namespace: Ontologies - PropertyFiltersNotSupported: - description: | - At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for - a list of supported property filters. + description: Returns objects where at least 1 query is satisfied. properties: - parameters: - properties: - propertyFilters: - items: - $ref: "#/components/schemas/PropertyFilter" - type: array - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - property - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + value: + items: + $ref: "#/components/schemas/SearchJsonQueryV2" + type: array + NotQueryV2: + type: object + x-namespace: Ontologies + description: Returns objects where the query is not satisfied. + properties: + value: + $ref: "#/components/schemas/SearchJsonQueryV2" + required: + - value + StartsWithQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field starts with the provided value. + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + required: + - field + - value + ContainsAllTermsInOrderQuery: + type: object x-namespace: Ontologies - PropertyTypesSearchNotSupported: description: | - The search on the property types are not supported. See the `Search Objects` documentation for - a list of supported search queries on different property types. + Returns objects where the specified field contains all of the terms in the order provided, + but they do have to be adjacent to each other. properties: - parameters: - properties: - parameters: - additionalProperties: - type: array - items: - $ref: "#/components/schemas/PropertyApiName" - x-mapKey: - $ref: "#/components/schemas/PropertyFilter" - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - errorInstanceId: + x-safety: unsafe + required: + - field + - value + ContainsAllTermsInOrderPrefixLastTerm: + type: object + x-namespace: Ontologies + 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.\n" + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + required: + - field + - value + ContainsAnyTermQuery: + type: object x-namespace: Ontologies - InvalidRangeQuery: - description: | - The specified query range filter is invalid. + 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" properties: - parameters: - properties: - lt: - description: Less than - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - field: - type: string - x-safety: unsafe - required: - - field - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/FuzzyV2" + required: + - field + - value + CenterPointTypes: + type: object x-namespace: Ontologies - QueryNotFound: - description: "The query is not found, or the user does not have access to it." - properties: - parameters: - properties: - query: - $ref: "#/components/schemas/QueryApiName" - required: - - query - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/GeoPoint" + oneOf: + - $ref: "#/components/schemas/GeoPoint" + WithinBoundingBoxPoint: + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/GeoPoint" + oneOf: + - $ref: "#/components/schemas/GeoPoint" + CenterPoint: + type: object x-namespace: Ontologies - UnknownParameter: description: | - The provided parameters were not found. Please look at the `knownParameters` field - to see which ones are available. + The coordinate point to use as the center of the distance query. properties: - parameters: - properties: - unknownParameters: - items: - $ref: "#/components/schemas/ParameterId" - type: array - expectedParameters: - items: - $ref: "#/components/schemas/ParameterId" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + center: + $ref: "#/components/schemas/CenterPointTypes" + distance: + $ref: "#/components/schemas/Distance" + required: + - center + - distance + WithinDistanceOfQuery: + type: object x-namespace: Ontologies - QueryEncounteredUserFacingError: description: | - The authored `Query` failed to execute because of a user induced error. The message argument - is meant to be displayed to the user. + Returns objects where the specified field contains a point within the distance provided of the center point. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - message: - type: string - x-safety: unsafe - required: - - functionRid - - functionVersion - - message - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/CenterPoint" + required: + - field + - value + BoundingBoxValue: + type: object x-namespace: Ontologies - QueryRuntimeError: description: | - The authored `Query` failed to execute because of a runtime error. + The top left and bottom right coordinate points that make up the bounding box. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - message: - type: string - x-safety: unsafe - stacktrace: - type: string - x-safety: unsafe - parameters: - additionalProperties: - type: string - x-safety: unsafe - x-mapKey: - $ref: "#/components/schemas/QueryRuntimeErrorParameter" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - QueryRuntimeErrorParameter: - type: string + topLeft: + $ref: "#/components/schemas/WithinBoundingBoxPoint" + bottomRight: + $ref: "#/components/schemas/WithinBoundingBoxPoint" + required: + - topLeft + - bottomRight + WithinBoundingBoxQuery: + type: object x-namespace: Ontologies - x-safety: unsafe - QueryTimeExceededLimit: description: | - Time limits were exceeded for the `Query` execution. + Returns objects where the specified field contains a point within the bounding box provided. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - TIMEOUT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/BoundingBoxValue" + required: + - field + - value + IntersectsBoundingBoxQuery: + type: object x-namespace: Ontologies - QueryMemoryExceededLimit: description: | - Memory limits were exceeded for the `Query` execution. + Returns objects where the specified field intersects the bounding box provided. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - TIMEOUT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - AggregationMetricName: - type: string - x-namespace: Ontologies - description: A user-specified alias for an aggregation metric name. - x-safety: unsafe - AggregationRange: - description: Specifies a date range from an inclusive start date to an exclusive end date. + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/BoundingBoxValue" + required: + - field + - value + DoesNotIntersectBoundingBoxQuery: type: object x-namespace: Ontologies + description: | + Returns objects where the specified field does not intersect the bounding box provided. properties: - lt: - description: Exclusive end date. - x-safety: unsafe - lte: - description: Inclusive end date. - x-safety: unsafe - gt: - description: Exclusive start date. - x-safety: unsafe - gte: - description: Inclusive start date. - x-safety: unsafe - Aggregation: - description: Specifies an aggregation function. - type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - max: "#/components/schemas/MaxAggregation" - min: "#/components/schemas/MinAggregation" - avg: "#/components/schemas/AvgAggregation" - sum: "#/components/schemas/SumAggregation" - count: "#/components/schemas/CountAggregation" - approximateDistinct: "#/components/schemas/ApproximateDistinctAggregation" - oneOf: - - $ref: "#/components/schemas/MaxAggregation" - - $ref: "#/components/schemas/MinAggregation" - - $ref: "#/components/schemas/AvgAggregation" - - $ref: "#/components/schemas/SumAggregation" - - $ref: "#/components/schemas/CountAggregation" - - $ref: "#/components/schemas/ApproximateDistinctAggregation" - AggregationGroupBy: - description: Specifies a grouping for aggregation results. + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/BoundingBoxValue" + required: + - field + - value + PolygonValue: type: object x-namespace: Ontologies discriminator: propertyName: type mapping: - fixedWidth: "#/components/schemas/AggregationFixedWidthGrouping" - ranges: "#/components/schemas/AggregationRangesGrouping" - exact: "#/components/schemas/AggregationExactGrouping" - duration: "#/components/schemas/AggregationDurationGrouping" + Polygon: "#/components/schemas/Polygon" oneOf: - - $ref: "#/components/schemas/AggregationFixedWidthGrouping" - - $ref: "#/components/schemas/AggregationRangesGrouping" - - $ref: "#/components/schemas/AggregationExactGrouping" - - $ref: "#/components/schemas/AggregationDurationGrouping" - AggregationOrderBy: - type: object - x-namespace: Ontologies - properties: - metricName: - type: string - x-safety: unsafe - required: - - metricName - AggregationFixedWidthGrouping: - description: Divides objects into groups with the specified width. + - $ref: "#/components/schemas/Polygon" + WithinPolygonQuery: type: object x-namespace: Ontologies + description: | + Returns objects where the specified field contains a point within the polygon provided. properties: field: - $ref: "#/components/schemas/FieldNameV1" - fixedWidth: - type: integer - x-safety: safe + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PolygonValue" required: - field - - fixedWidth - AggregationRangesGrouping: - description: Divides objects into groups according to specified ranges. + - value + IntersectsPolygonQuery: type: object x-namespace: Ontologies + description: | + Returns objects where the specified field intersects the polygon provided. properties: field: - $ref: "#/components/schemas/FieldNameV1" - ranges: - items: - $ref: "#/components/schemas/AggregationRange" - type: array + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PolygonValue" required: - field - AggregationExactGrouping: - description: Divides objects into groups according to an exact value. + - value + DoesNotIntersectPolygonQuery: type: object x-namespace: Ontologies + description: | + Returns objects where the specified field does not intersect the polygon provided. properties: field: - $ref: "#/components/schemas/FieldNameV1" - maxGroupCount: - type: integer - x-safety: safe + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PolygonValue" required: - field - AggregationDurationGrouping: - description: | - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. + - value + ContainsAllTermsQuery: type: object x-namespace: Ontologies + description: | + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. properties: field: - $ref: "#/components/schemas/FieldNameV1" - duration: - $ref: "#/components/schemas/Duration" + $ref: "#/components/schemas/PropertyApiName" + value: + type: string + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/FuzzyV2" required: - field - - duration - MaxAggregation: - description: Computes the maximum value for the provided field. + - value + FuzzyV2: + description: Setting fuzzy to `true` allows approximate matching in search queries that support it. + type: boolean + x-namespace: Ontologies + x-safety: safe + SearchOrderByV2: + description: Specifies the ordering of search results by a field and an ordering direction. type: object x-namespace: Ontologies properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" - required: - - field - MinAggregation: - description: Computes the minimum value for the provided field. + fields: + items: + $ref: "#/components/schemas/SearchOrderingV2" + type: array + SearchOrderingV2: type: object x-namespace: Ontologies properties: field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" + $ref: "#/components/schemas/PropertyApiName" + direction: + description: Specifies the ordering direction (can be either `asc` or `desc`) + type: string + x-safety: safe required: - field - AvgAggregation: - description: Computes the average value for the provided field. + ArtifactRepositoryRid: + type: string + format: rid + x-safety: safe + SdkPackageName: + type: string + x-safety: unsafe + ObjectSetRid: + type: string + format: rid + x-safety: safe + CreateTemporaryObjectSetRequestV2: type: object x-namespace: Ontologies properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" + objectSet: + $ref: "#/components/schemas/ObjectSet" required: - - field - SumAggregation: - description: Computes the sum of values for the provided field. + - objectSet + CreateTemporaryObjectSetResponseV2: type: object x-namespace: Ontologies properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" + objectSetRid: + $ref: "#/components/schemas/ObjectSetRid" required: - - field - CountAggregation: - description: Computes the total count of objects. + - objectSetRid + AggregateObjectSetRequestV2: type: object x-namespace: Ontologies properties: - name: - $ref: "#/components/schemas/AggregationMetricName" - ApproximateDistinctAggregation: - description: Computes an approximate number of distinct values for the provided field. + aggregation: + items: + $ref: "#/components/schemas/AggregationV2" + type: array + objectSet: + $ref: "#/components/schemas/ObjectSet" + groupBy: + items: + $ref: "#/components/schemas/AggregationGroupByV2" + type: array + accuracy: + $ref: "#/components/schemas/AggregationAccuracyRequest" + required: + - objectSet + ActionTypeV2: type: object x-namespace: Ontologies + description: Represents an action type in the Ontology. properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" + apiName: + $ref: "#/components/schemas/ActionTypeApiName" + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + parameters: + additionalProperties: + $ref: "#/components/schemas/ActionParameterV2" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + rid: + $ref: "#/components/schemas/ActionTypeRid" + operations: + type: array + items: + $ref: "#/components/schemas/LogicRule" required: - - field - InvalidAggregationRange: - description: | - Aggregation range should include one lt or lte and one gt or gte. + - apiName + - status + - rid + ActionParameterV2: + description: Details about a parameter of an action. properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + description: type: string - x-type: error - x-namespace: Ontologies - InvalidAggregationRangePropertyType: - description: | - Range group by is not supported by property type. + x-safety: unsafe + dataType: + $ref: "#/components/schemas/ActionParameterType" + required: + type: boolean + x-safety: safe + required: + - dataType + - required + type: object + x-namespace: Ontologies + BatchApplyActionRequestItem: + x-namespace: Ontologies + type: object properties: parameters: - type: object - properties: - property: - $ref: "#/components/schemas/PropertyApiName" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - property - - objectType - - propertyBaseType - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + BatchApplyActionRequestV2: + properties: + options: + $ref: "#/components/schemas/BatchApplyActionRequestOptions" + requests: + type: array + items: + $ref: "#/components/schemas/BatchApplyActionRequestItem" + type: object + x-namespace: Ontologies + BatchApplyActionResponseV2: + type: object x-namespace: Ontologies - InvalidAggregationRangeValue: - description: | - Aggregation value does not conform to the expected underlying type. properties: - parameters: - type: object - properties: - property: - $ref: "#/components/schemas/PropertyApiName" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - property - - objectType - - propertyBaseType - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + edits: + $ref: "#/components/schemas/ActionResults" + ListActionTypesResponseV2: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/ActionTypeV2" + type: array + type: object x-namespace: Ontologies - InvalidDurationGroupByPropertyType: - description: | - Invalid property type for duration groupBy. + ListInterfaceTypesResponse: properties: - parameters: - type: object - properties: - property: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/InterfaceType" + type: array + type: object + x-namespace: Ontologies + SearchObjectsForInterfaceRequest: + type: object + x-namespace: Ontologies + properties: + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + orderBy: + $ref: "#/components/schemas/SearchOrderByV2" + augmentedProperties: + 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" + additionalProperties: + items: $ref: "#/components/schemas/PropertyApiName" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - property - - objectType - - propertyBaseType - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + type: array + x-mapKey: + $ref: "#/components/schemas/ObjectTypeApiName" + augmentedSharedPropertyTypes: + 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" + additionalProperties: + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: array + x-mapKey: + $ref: "#/components/schemas/InterfaceTypeApiName" + selectedSharedPropertyTypes: + 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" + type: array + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + selectedObjectTypes: + 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" + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + otherInterfaceTypes: + 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" + type: array + items: + $ref: "#/components/schemas/InterfaceTypeApiName" + pageSize: + $ref: "#/components/schemas/PageSize" + pageToken: + $ref: "#/components/schemas/PageToken" + ListQueryTypesResponseV2: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/QueryTypeV2" + type: array + type: object + x-namespace: Ontologies + ListAttachmentsResponseV2: + type: object x-namespace: Ontologies - InvalidDurationGroupByValue: - description: | - Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support - filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by - every two hours are allowed. properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + data: + items: + $ref: "#/components/schemas/AttachmentV2" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + AttachmentMetadataResponse: + description: The attachment metadata response + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + single: "#/components/schemas/AttachmentV2" + multiple: "#/components/schemas/ListAttachmentsResponseV2" + oneOf: + - $ref: "#/components/schemas/AttachmentV2" + - $ref: "#/components/schemas/ListAttachmentsResponseV2" + AbsoluteTimeRange: + description: ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. + type: object x-namespace: Ontologies - MultipleGroupByOnFieldNotSupported: - description: | - Aggregation cannot group by on the same field multiple times. properties: - parameters: - type: object - properties: - duplicateFields: - items: - type: string - x-safety: unsafe - type: array - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: + startTime: type: string - errorInstanceId: + format: date-time + x-safety: unsafe + endTime: type: string - x-type: error + format: date-time + x-safety: unsafe + ActionMode: + x-namespace: Ontologies + enum: + - ASYNC + - RUN + - VALIDATE + AsyncApplyActionResponseV2: + type: object x-namespace: Ontologies - InvalidAggregationOrdering: - description: | - Aggregation ordering can only be applied to metrics with exactly one groupBy clause. properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: + operationId: type: string - errorInstanceId: - type: string - x-type: error + format: rid + x-safety: safe + required: + - operationId + SyncApplyActionResponseV2: + type: object x-namespace: Ontologies - DatasetNotFound: - description: "The requested dataset could not be found, or the client token does not have access to it." - properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - required: - - datasetRid - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CreateDatasetPermissionDenied: - description: The provided token does not have permission to create a dataset in this folder. properties: - parameters: - properties: - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - name: - $ref: "#/components/schemas/DatasetName" - required: - - parentFolderRid - - name - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - BranchAlreadyExists: - description: The branch cannot be created because a branch with that name already exists. + validation: + $ref: "#/components/schemas/ValidateActionResponseV2" + edits: + $ref: "#/components/schemas/ActionResults" + ActionResults: + discriminator: + propertyName: type + mapping: + edits: "#/components/schemas/ObjectEdits" + largeScaleEdits: "#/components/schemas/ObjectTypeEdits" + oneOf: + - $ref: "#/components/schemas/ObjectEdits" + - $ref: "#/components/schemas/ObjectTypeEdits" + ObjectTypeEdits: + type: object properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - InvalidBranchId: - description: The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. + editedObjectTypes: + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + ObjectEdits: + type: object properties: - parameters: - properties: - branchId: - $ref: "#/components/schemas/BranchId" - required: - - branchId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - BranchNotFound: - description: "The requested branch could not be found, or the client token does not have access to it." + edits: + type: array + items: + $ref: "#/components/schemas/ObjectEdit" + addedObjectCount: + type: integer + x-safety: safe + modifiedObjectsCount: + type: integer + x-safety: safe + deletedObjectsCount: + type: integer + x-safety: safe + addedLinksCount: + type: integer + x-safety: safe + deletedLinksCount: + type: integer + x-safety: safe + required: + - addedObjectCount + - modifiedObjectsCount + - deletedObjectsCount + - addedLinksCount + - deletedLinksCount + ObjectEdit: + discriminator: + propertyName: type + mapping: + addObject: "#/components/schemas/AddObject" + modifyObject: "#/components/schemas/ModifyObject" + addLink: "#/components/schemas/AddLink" + oneOf: + - $ref: "#/components/schemas/AddObject" + - $ref: "#/components/schemas/ModifyObject" + - $ref: "#/components/schemas/AddLink" + AddObject: + type: object properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CreateBranchPermissionDenied: - description: The provided token does not have permission to create a branch of this dataset. + primaryKey: + $ref: "#/components/schemas/PropertyValue" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - primaryKey + - objectType + ModifyObject: + type: object properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - DeleteBranchPermissionDenied: - description: The provided token does not have permission to delete the given branch from this dataset. + primaryKey: + $ref: "#/components/schemas/PropertyValue" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - primaryKey + - objectType + AddLink: + type: object properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CreateTransactionPermissionDenied: - description: The provided token does not have permission to create a transaction on this dataset. + linkTypeApiNameAtoB: + $ref: "#/components/schemas/LinkTypeApiName" + linkTypeApiNameBtoA: + $ref: "#/components/schemas/LinkTypeApiName" + aSideObject: + $ref: "#/components/schemas/LinkSideObject" + bSideObject: + $ref: "#/components/schemas/LinkSideObject" + required: + - linkTypeApiNameAtoB + - linkTypeApiNameBtoA + - aSideObject + - bSideObject + LinkSideObject: + type: object properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - OpenTransactionAlreadyExists: - description: A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. + primaryKey: + $ref: "#/components/schemas/PropertyValue" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - primaryKey + - objectType + LinkTypeRid: + type: string + format: rid + x-safety: safe + x-namespace: Ontologies + LinkTypeSideV2: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - TransactionNotOpen: - description: The given transaction is not open. + apiName: + $ref: "#/components/schemas/LinkTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + cardinality: + $ref: "#/components/schemas/LinkTypeSideCardinality" + foreignKeyPropertyApiName: + $ref: "#/components/schemas/PropertyApiName" + linkTypeRid: + $ref: "#/components/schemas/LinkTypeRid" + required: + - apiName + - displayName + - status + - objectTypeApiName + - cardinality + - linkTypeRid + ListOutgoingLinkTypesResponseV2: properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - transactionStatus: - $ref: "#/components/schemas/TransactionStatus" - required: - - datasetRid - - transactionRid - - transactionStatus - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - TransactionNotCommitted: - description: The given transaction has not been committed. + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of link type sides in the current page. + items: + $ref: "#/components/schemas/LinkTypeSideV2" + type: array + type: object + x-namespace: Ontologies + ApplyActionRequestV2: + x-namespace: Ontologies + type: object properties: + options: + $ref: "#/components/schemas/ApplyActionRequestOptions" parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - transactionStatus: - $ref: "#/components/schemas/TransactionStatus" - required: - - datasetRid - - transactionRid - - transactionStatus - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - TransactionNotFound: - description: "The requested transaction could not be found on the dataset, or the client token does not have access to it." + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + ApplyActionMode: + x-namespace: Ontologies + enum: + - VALIDATE_ONLY + - VALIDATE_AND_EXECUTE + ApplyActionRequestOptions: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - datasetRid - - transactionRid - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CommitTransactionPermissionDenied: - description: The provided token does not have permission to commit the given transaction on the given dataset. + mode: + $ref: "#/components/schemas/ApplyActionMode" + returnEdits: + $ref: "#/components/schemas/ReturnEditsMode" + BatchApplyActionRequestOptions: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - datasetRid - - transactionRid - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - AbortTransactionPermissionDenied: - description: The provided token does not have permission to abort the given transaction on the given dataset. + returnEdits: + $ref: "#/components/schemas/ReturnEditsMode" + ReturnEditsMode: + x-namespace: Ontologies + enum: + - ALL + - NONE + AsyncApplyActionRequestV2: properties: parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - datasetRid - - transactionRid - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - InvalidTransactionType: - description: "The given transaction type is not valid. Valid transaction types are `SNAPSHOT`, `UPDATE`, `APPEND`, and `DELETE`." + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + type: object + x-namespace: Ontologies + AsyncApplyActionOperationResponseV2: + type: object + x-namespace: Ontologies + AsyncApplyActionOperationV2: + x-type: + type: asyncOperation + operationType: applyActionAsyncV2 + resultType: AsyncApplyActionOperationResponseV2 + stageType: AsyncActionStatus + x-namespace: Ontologies + AttachmentV2: + type: object + x-namespace: Ontologies + description: The representation of an attachment. properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - transactionType: - $ref: "#/components/schemas/TransactionType" - required: - - datasetRid - - transactionRid - - transactionType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - UploadFilePermissionDenied: - description: The provided token does not have permission to upload the given file to the given dataset and transaction. + rid: + $ref: "#/components/schemas/AttachmentRid" + filename: + $ref: "#/components/schemas/Filename" + sizeBytes: + $ref: "#/components/schemas/SizeBytes" + mediaType: + $ref: "#/components/schemas/MediaType" + required: + - rid + - filename + - sizeBytes + - mediaType + ListLinkedObjectsResponseV2: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - path: - $ref: "#/components/schemas/FilePath" - required: - - datasetRid - - transactionRid - - path - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - FileNotFoundOnBranch: - description: "The requested file could not be found on the given branch, or the client token does not have access to it." + data: + items: + $ref: "#/components/schemas/OntologyObjectV2" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + ListObjectsResponseV2: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - path: - $ref: "#/components/schemas/FilePath" - required: - - datasetRid - - branchId - - path - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - FileNotFoundOnTransactionRange: - description: "The requested file could not be found on the given transaction range, or the client token does not have access to it." + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + type: array + description: The list of objects in the current page. + items: + $ref: "#/components/schemas/OntologyObjectV2" + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount + CountObjectsResponseV2: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - startTransactionRid: - $ref: "#/components/schemas/TransactionRid" - endTransactionRid: - $ref: "#/components/schemas/TransactionRid" - path: - $ref: "#/components/schemas/FilePath" - required: - - datasetRid - - endTransactionRid - - path - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - FileAlreadyExists: - description: The given file path already exists in the dataset and transaction. + count: + type: integer + x-safety: unsafe + LoadObjectSetResponseV2: + description: Represents the API response when loading an `ObjectSet`. + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - path: - $ref: "#/components/schemas/FilePath" - required: - - datasetRid - - transactionRid - - path - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: + data: + type: array + description: The list of objects in the current Page. + items: + $ref: "#/components/schemas/OntologyObjectV2" + nextPageToken: + $ref: "#/components/schemas/PageToken" + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount + LoadObjectSetRequestV2: + description: Represents the API POST body when loading an `ObjectSet`. + type: object + x-namespace: Ontologies + properties: + objectSet: + $ref: "#/components/schemas/ObjectSet" + orderBy: + $ref: "#/components/schemas/SearchOrderByV2" + select: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + pageToken: + $ref: "#/components/schemas/PageToken" + pageSize: + $ref: "#/components/schemas/PageSize" + excludeRid: + description: | + A flag to exclude the retrieval of the `__rid` property. + Setting this to true may improve performance of this endpoint for object types in OSV2. + type: boolean + x-safety: safe + required: + - objectSet + ObjectSet: + description: Represents the definition of an `ObjectSet` in the `Ontology`. + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + base: "#/components/schemas/ObjectSetBaseType" + static: "#/components/schemas/ObjectSetStaticType" + reference: "#/components/schemas/ObjectSetReferenceType" + filter: "#/components/schemas/ObjectSetFilterType" + union: "#/components/schemas/ObjectSetUnionType" + intersect: "#/components/schemas/ObjectSetIntersectionType" + subtract: "#/components/schemas/ObjectSetSubtractType" + searchAround: "#/components/schemas/ObjectSetSearchAroundType" + oneOf: + - $ref: "#/components/schemas/ObjectSetBaseType" + - $ref: "#/components/schemas/ObjectSetStaticType" + - $ref: "#/components/schemas/ObjectSetReferenceType" + - $ref: "#/components/schemas/ObjectSetFilterType" + - $ref: "#/components/schemas/ObjectSetUnionType" + - $ref: "#/components/schemas/ObjectSetIntersectionType" + - $ref: "#/components/schemas/ObjectSetSubtractType" + - $ref: "#/components/schemas/ObjectSetSearchAroundType" + ObjectSetBaseType: + type: object + x-namespace: Ontologies + properties: + objectType: type: string - errorInstanceId: + x-safety: unsafe + required: + - objectType + ObjectSetStaticType: + type: object + x-namespace: Ontologies + properties: + objects: + type: array + items: + $ref: "#/components/schemas/ObjectRid" + ObjectSetReferenceType: + type: object + x-namespace: Ontologies + properties: + reference: type: string - x-type: error - x-namespace: Datasets - SchemaNotFound: - description: "A schema could not be found for the given dataset and branch, or the client token does not have access to it." + format: rid + x-safety: safe + required: + - reference + ObjectSetFilterType: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - PutSchemaPermissionDenied: - description: todo + objectSet: + $ref: "#/components/schemas/ObjectSet" + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + required: + - objectSet + - where + ObjectSetUnionType: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - DeleteSchemaPermissionDenied: - description: todo + objectSets: + type: array + items: + $ref: "#/components/schemas/ObjectSet" + ObjectSetIntersectionType: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - datasetRid - - branchId - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - ReadTablePermissionDenied: - description: The provided token does not have permission to read the given dataset as a table. + objectSets: + type: array + items: + $ref: "#/components/schemas/ObjectSet" + ObjectSetSubtractType: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - required: - - datasetRid - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - DatasetReadNotSupported: - description: The dataset does not support being read. + objectSets: + type: array + items: + $ref: "#/components/schemas/ObjectSet" + ObjectSetSearchAroundType: + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - required: - - datasetRid - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - ColumnTypesNotSupported: - description: The dataset contains column types that are not supported. + objectSet: + $ref: "#/components/schemas/ObjectSet" + link: + $ref: "#/components/schemas/LinkTypeApiName" + required: + - objectSet + - link + OntologyV2: + $ref: "#/components/schemas/Ontology" + OntologyFullMetadata: properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - required: - - datasetRid - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: + ontology: + $ref: "#/components/schemas/OntologyV2" + objectTypes: + additionalProperties: + $ref: "#/components/schemas/ObjectTypeFullMetadata" + x-mapKey: + $ref: "#/components/schemas/ObjectTypeApiName" + actionTypes: + additionalProperties: + $ref: "#/components/schemas/ActionTypeV2" + x-mapKey: + $ref: "#/components/schemas/ActionTypeApiName" + queryTypes: + additionalProperties: + $ref: "#/components/schemas/QueryTypeV2" + x-mapKey: + $ref: "#/components/schemas/QueryApiName" + interfaceTypes: + additionalProperties: + $ref: "#/components/schemas/InterfaceType" + x-mapKey: + $ref: "#/components/schemas/InterfaceTypeApiName" + sharedPropertyTypes: + additionalProperties: + $ref: "#/components/schemas/SharedPropertyType" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: object + x-namespace: Ontologies + required: + - ontology + OntologyObjectV2: + description: Represents an object in the Ontology. + additionalProperties: + $ref: "#/components/schemas/PropertyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + x-namespace: Ontologies + OntologyIdentifier: + description: Either an ontology rid or an ontology api name. + type: string + x-safety: unsafe + x-namespace: Ontologies + QueryTypeV2: + description: Represents a query type in the Ontology. + properties: + apiName: + $ref: "#/components/schemas/QueryApiName" + description: type: string - errorInstanceId: + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + parameters: + additionalProperties: + $ref: "#/components/schemas/QueryParameterV2" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + output: + $ref: "#/components/schemas/QueryDataType" + rid: + $ref: "#/components/schemas/FunctionRid" + version: + $ref: "#/components/schemas/FunctionVersion" + required: + - apiName + - rid + - version + - output + type: object + x-namespace: Ontologies + QueryParameterV2: + type: object + description: Details about a parameter of a query. + properties: + description: type: string - x-type: error - x-namespace: Datasets - ActionParameterArrayType: + x-safety: unsafe + dataType: + $ref: "#/components/schemas/QueryDataType" + required: + - dataType + QueryOutputV2: type: object + description: Details about the output of a query. properties: - subType: - $ref: "#/components/schemas/ActionParameterType" + dataType: + $ref: "#/components/schemas/QueryDataType" + required: + type: boolean + x-safety: safe required: - - subType - ActionParameterType: + - dataType + - required + RelativeTimeSeriesTimeUnit: + enum: + - MILLISECONDS + - SECONDS + - MINUTES + - HOURS + - DAYS + - WEEKS + - MONTHS + - YEARS + RelativeTime: description: | - A union of all the types supported by Ontology Action parameters. + A relative time, such as "3 days before" or "2 hours after" the current moment. + type: object + x-namespace: Ontologies + properties: + when: + $ref: "#/components/schemas/RelativeTimeRelation" + value: + type: integer + x-safety: unsafe + unit: + $ref: "#/components/schemas/RelativeTimeSeriesTimeUnit" + required: + - when + - value + - unit + RelativeTimeRelation: + enum: + - BEFORE + - AFTER + RelativeTimeRange: + description: | + A relative time range for a time series query. + type: object + x-namespace: Ontologies + properties: + startTime: + $ref: "#/components/schemas/RelativeTime" + endTime: + $ref: "#/components/schemas/RelativeTime" + SearchObjectsRequestV2: + type: object + x-namespace: Ontologies + properties: + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + orderBy: + $ref: "#/components/schemas/SearchOrderByV2" + pageSize: + $ref: "#/components/schemas/PageSize" + pageToken: + $ref: "#/components/schemas/PageToken" + select: + description: | + The API names of the object type properties to include in the response. + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + excludeRid: + description: | + A flag to exclude the retrieval of the `__rid` property. + Setting this to true may improve performance of this endpoint for object types in OSV2. + type: boolean + x-safety: safe + SearchObjectsResponseV2: + type: object + x-namespace: Ontologies + properties: + data: + items: + $ref: "#/components/schemas/OntologyObjectV2" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount + StreamTimeSeriesPointsRequest: + type: object + x-namespace: Ontologies + properties: + range: + $ref: "#/components/schemas/TimeRange" + StreamTimeSeriesPointsResponse: + type: object + x-namespace: Ontologies + properties: + data: + items: + $ref: "#/components/schemas/TimeSeriesPoint" + type: array + TimeRange: + description: An absolute or relative range for a time series query. + type: object + x-namespace: Ontologies discriminator: propertyName: type mapping: - array: "#/components/schemas/ActionParameterArrayType" - attachment: "#/components/schemas/AttachmentType" - boolean: "#/components/schemas/BooleanType" - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - integer: "#/components/schemas/IntegerType" - long: "#/components/schemas/LongType" - marking: "#/components/schemas/MarkingType" - objectSet: "#/components/schemas/OntologyObjectSetType" - object: "#/components/schemas/OntologyObjectType" - string: "#/components/schemas/StringType" - timestamp: "#/components/schemas/TimestampType" + absolute: "#/components/schemas/AbsoluteTimeRange" + relative: "#/components/schemas/RelativeTimeRange" oneOf: - - $ref: "#/components/schemas/ActionParameterArrayType" - - $ref: "#/components/schemas/AttachmentType" - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/LongType" - - $ref: "#/components/schemas/MarkingType" - - $ref: "#/components/schemas/OntologyObjectSetType" - - $ref: "#/components/schemas/OntologyObjectType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/TimestampType" - OntologyDataType: + - $ref: "#/components/schemas/AbsoluteTimeRange" + - $ref: "#/components/schemas/RelativeTimeRange" + TimeSeriesPoint: description: | - A union of all the primitive types used by Palantir's Ontology-based products. + A time and value pair. + type: object + properties: + time: + description: An ISO 8601 timestamp + type: string + format: date-time + x-safety: unsafe + value: + description: An object which is either an enum String or a double number. + x-safety: unsafe + required: + - time + - value + ValidateActionResponseV2: + type: object + x-namespace: Ontologies + properties: + result: + $ref: "#/components/schemas/ValidationResult" + submissionCriteria: + items: + $ref: "#/components/schemas/SubmissionCriteriaEvaluation" + type: array + parameters: + additionalProperties: + $ref: "#/components/schemas/ParameterEvaluationResult" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + required: + - result + PropertyV2: + description: Details about some property of an object. + properties: + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + dataType: + $ref: "#/components/schemas/ObjectPropertyType" + required: + - dataType + type: object + x-namespace: Ontologies + OntologyObjectArrayType: + type: object + properties: + subType: + $ref: "#/components/schemas/ObjectPropertyType" + required: + - subType + ObjectPropertyType: + description: | + A union of all the types supported by Ontology Object properties. discriminator: propertyName: type mapping: - any: "#/components/schemas/AnyType" - binary: "#/components/schemas/BinaryType" + array: "#/components/schemas/OntologyObjectArrayType" + attachment: "#/components/schemas/AttachmentType" boolean: "#/components/schemas/BooleanType" byte: "#/components/schemas/ByteType" date: "#/components/schemas/DateType" decimal: "#/components/schemas/DecimalType" double: "#/components/schemas/DoubleType" float: "#/components/schemas/FloatType" + geopoint: "#/components/schemas/GeoPointType" + geoshape: "#/components/schemas/GeoShapeType" integer: "#/components/schemas/IntegerType" long: "#/components/schemas/LongType" marking: "#/components/schemas/MarkingType" short: "#/components/schemas/ShortType" string: "#/components/schemas/StringType" timestamp: "#/components/schemas/TimestampType" - array: "#/components/schemas/OntologyArrayType" - map: "#/components/schemas/OntologyMapType" - set: "#/components/schemas/OntologySetType" - struct: "#/components/schemas/OntologyStructType" - object: "#/components/schemas/OntologyObjectType" - objectSet: "#/components/schemas/OntologyObjectSetType" - unsupported: "#/components/schemas/UnsupportedType" + timeseries: "#/components/schemas/TimeseriesType" oneOf: - - $ref: "#/components/schemas/AnyType" - - $ref: "#/components/schemas/BinaryType" + - $ref: "#/components/schemas/OntologyObjectArrayType" + - $ref: "#/components/schemas/AttachmentType" - $ref: "#/components/schemas/BooleanType" - $ref: "#/components/schemas/ByteType" - $ref: "#/components/schemas/DateType" - $ref: "#/components/schemas/DecimalType" - $ref: "#/components/schemas/DoubleType" - $ref: "#/components/schemas/FloatType" + - $ref: "#/components/schemas/GeoPointType" + - $ref: "#/components/schemas/GeoShapeType" - $ref: "#/components/schemas/IntegerType" - $ref: "#/components/schemas/LongType" - $ref: "#/components/schemas/MarkingType" - $ref: "#/components/schemas/ShortType" - $ref: "#/components/schemas/StringType" - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/OntologyArrayType" - - $ref: "#/components/schemas/OntologyMapType" - - $ref: "#/components/schemas/OntologySetType" - - $ref: "#/components/schemas/OntologyStructType" - - $ref: "#/components/schemas/OntologyObjectType" - - $ref: "#/components/schemas/OntologyObjectSetType" - - $ref: "#/components/schemas/UnsupportedType" - OntologyObjectSetType: - type: object - properties: - objectApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - OntologyObjectType: + - $ref: "#/components/schemas/TimeseriesType" + BlueprintIcon: type: object properties: - objectApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + color: + description: A hexadecimal color code. + type: string + x-safety: safe + name: + 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" + type: string + x-safety: unsafe required: - - objectApiName - - objectTypeApiName - OntologyArrayType: - type: object + - color + - name + Icon: + description: A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). + discriminator: + propertyName: type + mapping: + blueprint: "#/components/schemas/BlueprintIcon" + oneOf: + - $ref: "#/components/schemas/BlueprintIcon" + ObjectTypeV2: + description: Represents an object type in the Ontology. properties: - itemType: - $ref: "#/components/schemas/OntologyDataType" - required: - - itemType - OntologyMapType: - type: object - properties: - keyType: - $ref: "#/components/schemas/OntologyDataType" - valueType: - $ref: "#/components/schemas/OntologyDataType" - required: - - keyType - - valueType - OntologySetType: - type: object - properties: - itemType: - $ref: "#/components/schemas/OntologyDataType" + apiName: + $ref: "#/components/schemas/ObjectTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + description: + description: The description of the object type. + type: string + x-safety: unsafe + pluralDisplayName: + description: The plural display name of the object type. + type: string + x-safety: unsafe + icon: + $ref: "#/components/schemas/Icon" + primaryKey: + $ref: "#/components/schemas/PropertyApiName" + properties: + description: A map of the properties of the object type. + additionalProperties: + $ref: "#/components/schemas/PropertyV2" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + rid: + $ref: "#/components/schemas/ObjectTypeRid" + titleProperty: + $ref: "#/components/schemas/PropertyApiName" + visibility: + $ref: "#/components/schemas/ObjectTypeVisibility" required: - - itemType - OntologyStructType: + - apiName + - status + - rid + - primaryKey + - titleProperty + - displayName + - pluralDisplayName + - icon type: object + x-namespace: Ontologies + ListObjectTypesV2Response: properties: - fields: - type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of object types in the current page. items: - $ref: "#/components/schemas/OntologyStructField" - OntologyStructField: - type: object - properties: - name: - $ref: "#/components/schemas/StructFieldName" - fieldType: - $ref: "#/components/schemas/OntologyDataType" - required: - type: boolean - x-safety: safe - required: - - name - - required - - fieldType - QueryDataType: - description: | - A union of all the types supported by Ontology Query parameters or outputs. - discriminator: - propertyName: type - mapping: - array: "#/components/schemas/QueryArrayType" - attachment: "#/components/schemas/AttachmentType" - boolean: "#/components/schemas/BooleanType" - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - float: "#/components/schemas/FloatType" - integer: "#/components/schemas/IntegerType" - long: "#/components/schemas/LongType" - objectSet: "#/components/schemas/OntologyObjectSetType" - object: "#/components/schemas/OntologyObjectType" - set: "#/components/schemas/QuerySetType" - string: "#/components/schemas/StringType" - struct: "#/components/schemas/QueryStructType" - threeDimensionalAggregation: "#/components/schemas/ThreeDimensionalAggregation" - timestamp: "#/components/schemas/TimestampType" - twoDimensionalAggregation: "#/components/schemas/TwoDimensionalAggregation" - union: "#/components/schemas/QueryUnionType" - "null": "#/components/schemas/NullType" - unsupported: "#/components/schemas/UnsupportedType" - oneOf: - - $ref: "#/components/schemas/QueryArrayType" - - $ref: "#/components/schemas/AttachmentType" - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/FloatType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/LongType" - - $ref: "#/components/schemas/OntologyObjectSetType" - - $ref: "#/components/schemas/OntologyObjectType" - - $ref: "#/components/schemas/QuerySetType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/QueryStructType" - - $ref: "#/components/schemas/ThreeDimensionalAggregation" - - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/TwoDimensionalAggregation" - - $ref: "#/components/schemas/QueryUnionType" - - $ref: "#/components/schemas/NullType" - - $ref: "#/components/schemas/UnsupportedType" - QueryArrayType: + $ref: "#/components/schemas/ObjectTypeV2" + type: array type: object + x-namespace: Ontologies + ListOntologiesV2Response: properties: - subType: - $ref: "#/components/schemas/QueryDataType" - required: - - subType - QuerySetType: + data: + description: The list of Ontologies the user has access to. + items: + $ref: "#/components/schemas/OntologyV2" + type: array type: object + x-namespace: Ontologies + ObjectTypeInterfaceImplementation: properties: - subType: - $ref: "#/components/schemas/QueryDataType" - required: - - subType - QueryStructType: + properties: + additionalProperties: + $ref: "#/components/schemas/PropertyApiName" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" type: object + x-namespace: Ontologies + ObjectTypeFullMetadata: properties: - fields: + objectType: + $ref: "#/components/schemas/ObjectTypeV2" + linkTypes: type: array items: - $ref: "#/components/schemas/QueryStructField" - QueryStructField: + $ref: "#/components/schemas/LinkTypeSideV2" + implementsInterfaces: + description: A list of interfaces that this object type implements. + type: array + items: + $ref: "#/components/schemas/InterfaceTypeApiName" + implementsInterfaces2: + description: A list of interfaces that this object type implements and how it implements them. + additionalProperties: + $ref: "#/components/schemas/ObjectTypeInterfaceImplementation" + x-mapKey: + $ref: "#/components/schemas/InterfaceTypeApiName" + x-safety: unsafe + sharedPropertyTypeMapping: + 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" + additionalProperties: + $ref: "#/components/schemas/PropertyApiName" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" type: object - properties: - name: - $ref: "#/components/schemas/StructFieldName" - fieldType: - $ref: "#/components/schemas/QueryDataType" + x-namespace: Ontologies required: - - name - - fieldType - QueryUnionType: + - objectType + InterfaceTypeApiName: + description: | + The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface + type, use the `List interface types` endpoint or check the **Ontology Manager**. + type: string + x-namespace: Ontologies + x-safety: unsafe + InterfaceTypeRid: + description: "The unique resource identifier of an interface, useful for interacting with other Foundry APIs." + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + InterfaceLinkTypeRid: + description: | + The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + InterfaceLinkTypeApiName: + description: A string indicating the API name to use for the interface link. + type: string + x-namespace: Ontologies + x-safety: unsafe + LinkedInterfaceTypeApiName: + description: A reference to the linked interface type. type: object properties: - unionTypes: - type: array - items: - $ref: "#/components/schemas/QueryDataType" - QueryAggregationRangeType: + apiName: + $ref: "#/components/schemas/InterfaceTypeApiName" + required: + - apiName + LinkedObjectTypeApiName: + description: A reference to the linked object type. type: object properties: - subType: - $ref: "#/components/schemas/QueryAggregationRangeSubType" + apiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - subType - QueryAggregationRangeSubType: - description: | - A union of all the types supported by query aggregation ranges. + - apiName + InterfaceLinkTypeLinkedEntityApiName: + description: A reference to the linked entity. This can either be an object or an interface type. discriminator: propertyName: type mapping: - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - integer: "#/components/schemas/IntegerType" - timestamp: "#/components/schemas/TimestampType" + interfaceTypeApiName: "#/components/schemas/LinkedInterfaceTypeApiName" + objectTypeApiName: "#/components/schemas/LinkedObjectTypeApiName" oneOf: - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/TimestampType" - QueryAggregationKeyType: + - $ref: "#/components/schemas/LinkedInterfaceTypeApiName" + - $ref: "#/components/schemas/LinkedObjectTypeApiName" + InterfaceLinkTypeCardinality: description: | - A union of all the types supported by query aggregation keys. - discriminator: - propertyName: type - mapping: - boolean: "#/components/schemas/BooleanType" - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - integer: "#/components/schemas/IntegerType" - string: "#/components/schemas/StringType" - timestamp: "#/components/schemas/TimestampType" - range: "#/components/schemas/QueryAggregationRangeType" - oneOf: - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/QueryAggregationRangeType" - QueryAggregationValueType: + The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can + link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. + enum: + - ONE + - MANY + InterfaceLinkType: description: | - A union of all the types supported by query aggregation keys. - discriminator: - propertyName: type - mapping: - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - timestamp: "#/components/schemas/TimestampType" - oneOf: - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/TimestampType" - TwoDimensionalAggregation: + A link type constraint defined at the interface level where the implementation of the links is provided + by the implementing object types. type: object + x-namespace: Ontologies properties: - keyType: - $ref: "#/components/schemas/QueryAggregationKeyType" - valueType: - $ref: "#/components/schemas/QueryAggregationValueType" + rid: + $ref: "#/components/schemas/InterfaceLinkTypeRid" + apiName: + $ref: "#/components/schemas/InterfaceLinkTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + description: + description: The description of the interface link type. + type: string + x-safety: unsafe + linkedEntityApiName: + $ref: "#/components/schemas/InterfaceLinkTypeLinkedEntityApiName" + cardinality: + $ref: "#/components/schemas/InterfaceLinkTypeCardinality" + required: + description: | + Whether each implementing object type must declare at least one implementation of this link. + type: boolean + x-safety: safe required: - - keyType - - valueType - ThreeDimensionalAggregation: + - rid + - apiName + - displayName + - linkedEntityApiName + - cardinality + - required + InterfaceType: type: object + x-namespace: Ontologies + description: Represents an interface type in the Ontology. properties: - keyType: - $ref: "#/components/schemas/QueryAggregationKeyType" - valueType: - $ref: "#/components/schemas/TwoDimensionalAggregation" + rid: + $ref: "#/components/schemas/InterfaceTypeRid" + apiName: + $ref: "#/components/schemas/InterfaceTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + description: + description: The description of the interface. + type: string + x-safety: unsafe + properties: + 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.\n" + additionalProperties: + $ref: "#/components/schemas/SharedPropertyType" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + extendsInterfaces: + description: "A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n" + type: array + items: + $ref: "#/components/schemas/InterfaceTypeApiName" + links: + description: | + A map from an interface link type API name to the corresponding interface link type. The map describes the + set of link types the interface has. + additionalProperties: + $ref: "#/components/schemas/InterfaceLinkType" + x-mapKey: + $ref: "#/components/schemas/InterfaceLinkTypeApiName" required: - - keyType - - valueType - ValueType: - type: string - x-safety: safe - description: | - A string indicating the type of each data value. Note that these types can be nested, for example an array of - structs. - - | Type | JSON value | - |---------------------|-------------------------------------------------------------------------------------------------------------------| - | Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | - | Attachment | `Attachment` | - | Boolean | `Boolean` | - | Byte | `Byte` | - | Date | `LocalDate` | - | Decimal | `Decimal` | - | Double | `Double` | - | Float | `Float` | - | Integer | `Integer` | - | Long | `Long` | - | Marking | `Marking` | - | OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | - | Short | `Short` | - | String | `String` | - | Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | - | Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | - | Timestamp | `Timestamp` | - ArraySizeConstraint: - description: | - The parameter expects an array of values and the size of the array must fall within the defined range. - type: object + - rid + - apiName + - displayName + InterfaceTypeNotFound: + description: "The requested interface type is not found, or the client token does not have access to it." properties: - lt: - description: Less than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - GroupMemberConstraint: - description: | - The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - type: object + parameters: + properties: + apiName: + $ref: "#/components/schemas/InterfaceTypeApiName" + rid: + $ref: "#/components/schemas/InterfaceTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectPropertyValueConstraint: + SharedPropertyTypeNotFound: + description: "The requested shared property type is not found, or the client token does not have access to it." + properties: + parameters: + properties: + apiName: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + rid: + $ref: "#/components/schemas/SharedPropertyTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + PropertiesHaveDifferentIds: description: | - The parameter value must be a property value of an object found within an object set. - type: object + Properties used in ordering must have the same ids. Temporary restriction imposed due to OSS limitations. + properties: + parameters: + properties: + properties: + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectQueryResultConstraint: + SharedPropertiesNotFound: + description: The requested shared property types are not present on every object type. + properties: + parameters: + properties: + objectType: + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + missingSharedProperties: + type: array + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + SharedPropertyTypeApiName: description: | - The parameter value must be the primary key of an object found within an object set. - type: object + The name of the shared property type in the API in lowerCamelCase format. To find the API name for your + shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. + type: string x-namespace: Ontologies - OneOfConstraint: + x-safety: unsafe + SharedPropertyTypeRid: description: | - The parameter has a manually predefined set of options. + The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + SharedPropertyType: type: object x-namespace: Ontologies + description: A property type that can be shared across object types. properties: - options: - type: array - items: - $ref: "#/components/schemas/ParameterOption" - otherValuesAllowed: - 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**." - type: boolean - x-safety: unsafe - required: - - otherValuesAllowed - RangeConstraint: - description: | - The parameter value must be within the defined range. - type: object - x-namespace: Ontologies - properties: - lt: - description: Less than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - StringLengthConstraint: - description: | - The parameter value must have a length within the defined range. - *This range is always inclusive.* - type: object - x-namespace: Ontologies - properties: - lt: - description: Less than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - StringRegexMatchConstraint: - description: | - The parameter value must match a predefined regular expression. - type: object - x-namespace: Ontologies - properties: - regex: - description: The regular expression configured in the **Ontology Manager**. - type: string - x-safety: unsafe - configuredFailureMessage: - description: | - The message indicating that the regular expression was not matched. - This is configured per parameter in the **Ontology Manager**. + rid: + $ref: "#/components/schemas/SharedPropertyTypeRid" + apiName: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + description: type: string + description: A short text that describes the SharedPropertyType. x-safety: unsafe + dataType: + $ref: "#/components/schemas/ObjectPropertyType" required: - - regex - UnevaluableConstraint: - description: | - 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. + - rid + - apiName + - displayName + - dataType + AggregateObjectsRequestV2: type: object x-namespace: Ontologies - ParameterEvaluatedConstraint: - 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" + properties: + aggregation: + items: + $ref: "#/components/schemas/AggregationV2" + type: array + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + groupBy: + items: + $ref: "#/components/schemas/AggregationGroupByV2" + type: array + accuracy: + $ref: "#/components/schemas/AggregationAccuracyRequest" + AggregationV2: + description: Specifies an aggregation function. type: object x-namespace: Ontologies discriminator: propertyName: type mapping: - arraySize: "#/components/schemas/ArraySizeConstraint" - groupMember: "#/components/schemas/GroupMemberConstraint" - objectPropertyValue: "#/components/schemas/ObjectPropertyValueConstraint" - objectQueryResult: "#/components/schemas/ObjectQueryResultConstraint" - oneOf: "#/components/schemas/OneOfConstraint" - range: "#/components/schemas/RangeConstraint" - stringLength: "#/components/schemas/StringLengthConstraint" - stringRegexMatch: "#/components/schemas/StringRegexMatchConstraint" - unevaluable: "#/components/schemas/UnevaluableConstraint" + max: "#/components/schemas/MaxAggregationV2" + min: "#/components/schemas/MinAggregationV2" + avg: "#/components/schemas/AvgAggregationV2" + sum: "#/components/schemas/SumAggregationV2" + count: "#/components/schemas/CountAggregationV2" + approximateDistinct: "#/components/schemas/ApproximateDistinctAggregationV2" + approximatePercentile: "#/components/schemas/ApproximatePercentileAggregationV2" + exactDistinct: "#/components/schemas/ExactDistinctAggregationV2" oneOf: - - $ref: "#/components/schemas/ArraySizeConstraint" - - $ref: "#/components/schemas/GroupMemberConstraint" - - $ref: "#/components/schemas/ObjectPropertyValueConstraint" - - $ref: "#/components/schemas/ObjectQueryResultConstraint" - - $ref: "#/components/schemas/OneOfConstraint" - - $ref: "#/components/schemas/RangeConstraint" - - $ref: "#/components/schemas/StringLengthConstraint" - - $ref: "#/components/schemas/StringRegexMatchConstraint" - - $ref: "#/components/schemas/UnevaluableConstraint" - ParameterEvaluationResult: - description: Represents the validity of a parameter against the configured constraints. + - $ref: "#/components/schemas/MaxAggregationV2" + - $ref: "#/components/schemas/MinAggregationV2" + - $ref: "#/components/schemas/AvgAggregationV2" + - $ref: "#/components/schemas/SumAggregationV2" + - $ref: "#/components/schemas/CountAggregationV2" + - $ref: "#/components/schemas/ApproximateDistinctAggregationV2" + - $ref: "#/components/schemas/ApproximatePercentileAggregationV2" + - $ref: "#/components/schemas/ExactDistinctAggregationV2" + MaxAggregationV2: + description: Computes the maximum value for the provided field. type: object x-namespace: Ontologies properties: - result: - $ref: "#/components/schemas/ValidationResult" - evaluatedConstraints: - type: array - items: - $ref: "#/components/schemas/ParameterEvaluatedConstraint" - required: - description: Represents whether the parameter is a required input to the action. - type: boolean - x-safety: unsafe + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" required: - - result - - required - ParameterOption: - description: | - A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. + - field + MinAggregationV2: + description: Computes the minimum value for the provided field. type: object x-namespace: Ontologies properties: - displayName: - $ref: "#/components/schemas/DisplayName" - value: - description: An allowed configured value for a parameter within an action. - x-safety: unsafe - ActionType: - description: Represents an action type in the Ontology. - properties: - apiName: - $ref: "#/components/schemas/ActionTypeApiName" - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - parameters: - additionalProperties: - $ref: "#/components/schemas/Parameter" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - rid: - $ref: "#/components/schemas/ActionTypeRid" - operations: - type: array - items: - $ref: "#/components/schemas/LogicRule" + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" required: - - apiName - - status - - rid + - field + AvgAggregationV2: + description: Computes the average value for the provided field. type: object x-namespace: Ontologies - LogicRule: - discriminator: - propertyName: type - mapping: - createObject: "#/components/schemas/CreateObjectRule" - modifyObject: "#/components/schemas/ModifyObjectRule" - deleteObject: "#/components/schemas/DeleteObjectRule" - createLink: "#/components/schemas/CreateLinkRule" - deleteLink: "#/components/schemas/DeleteLinkRule" - oneOf: - - $ref: "#/components/schemas/CreateObjectRule" - - $ref: "#/components/schemas/ModifyObjectRule" - - $ref: "#/components/schemas/DeleteObjectRule" - - $ref: "#/components/schemas/CreateLinkRule" - - $ref: "#/components/schemas/DeleteLinkRule" - CreateObjectRule: - type: object properties: - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" required: - - objectTypeApiName - ModifyObjectRule: + - field + SumAggregationV2: + description: Computes the sum of values for the provided field. type: object + x-namespace: Ontologies properties: - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" required: - - objectTypeApiName - DeleteObjectRule: + - field + CountAggregationV2: + description: Computes the total count of objects. type: object + x-namespace: Ontologies properties: - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectTypeApiName - CreateLinkRule: + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + ApproximateDistinctAggregationV2: + description: Computes an approximate number of distinct values for the provided field. type: object + x-namespace: Ontologies properties: - linkTypeApiNameAtoB: - $ref: "#/components/schemas/LinkTypeApiName" - linkTypeApiNameBtoA: - $ref: "#/components/schemas/LinkTypeApiName" - aSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - bSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" required: - - linkTypeApiNameAtoB - - linkTypeApiNameBtoA - - aSideObjectTypeApiName - - bSideObjectTypeApiName - DeleteLinkRule: + - field + ExactDistinctAggregationV2: + description: Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. type: object + x-namespace: Ontologies properties: - linkTypeApiNameAtoB: - $ref: "#/components/schemas/LinkTypeApiName" - linkTypeApiNameBtoA: - $ref: "#/components/schemas/LinkTypeApiName" - aSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - bSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" required: - - linkTypeApiNameAtoB - - linkTypeApiNameBtoA - - aSideObjectTypeApiName - - bSideObjectTypeApiName - ActionTypeApiName: - description: | - The name of the action type in the API. To find the API name for your Action Type, use the `List action types` - endpoint or check the **Ontology Manager**. - type: string - x-safety: unsafe - x-namespace: Ontologies - ActionTypeRid: - description: | - The unique resource identifier of an action type, useful for interacting with other Foundry APIs. - format: rid - type: string - x-safety: safe + - field + ApproximatePercentileAggregationV2: + description: Computes the approximate percentile value for the provided field. Requires Object Storage V2. + type: object x-namespace: Ontologies - ApplyActionRequest: properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + approximatePercentile: + type: number + format: double + x-safety: safe + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + - approximatePercentile + OrderByDirection: + x-namespace: Ontologies + enum: + - ASC + - DESC + AggregationGroupByV2: + description: Specifies a grouping for aggregation results. type: object x-namespace: Ontologies - BatchApplyActionRequest: + discriminator: + propertyName: type + mapping: + fixedWidth: "#/components/schemas/AggregationFixedWidthGroupingV2" + ranges: "#/components/schemas/AggregationRangesGroupingV2" + exact: "#/components/schemas/AggregationExactGroupingV2" + duration: "#/components/schemas/AggregationDurationGroupingV2" + oneOf: + - $ref: "#/components/schemas/AggregationFixedWidthGroupingV2" + - $ref: "#/components/schemas/AggregationRangesGroupingV2" + - $ref: "#/components/schemas/AggregationExactGroupingV2" + - $ref: "#/components/schemas/AggregationDurationGroupingV2" + AggregationAccuracyRequest: + x-namespace: Ontologies + enum: + - REQUIRE_ACCURATE + - ALLOW_APPROXIMATE + AggregationAccuracy: + x-namespace: Ontologies + enum: + - ACCURATE + - APPROXIMATE + AggregateObjectsResponseV2: properties: - requests: - type: array + excludedItems: + type: integer + x-safety: unsafe + accuracy: + $ref: "#/components/schemas/AggregationAccuracy" + data: items: - $ref: "#/components/schemas/ApplyActionRequest" + $ref: "#/components/schemas/AggregateObjectsResponseItemV2" + type: array + type: object + required: + - accuracy + x-namespace: Ontologies + AggregateObjectsResponseItemV2: type: object x-namespace: Ontologies - AsyncApplyActionRequest: properties: - parameters: - nullable: true + group: additionalProperties: - $ref: "#/components/schemas/DataValue" + $ref: "#/components/schemas/AggregationGroupValueV2" x-mapKey: - $ref: "#/components/schemas/ParameterId" - type: object - x-namespace: Ontologies - ApplyActionResponse: - type: object - x-namespace: Ontologies - BatchApplyActionResponse: + $ref: "#/components/schemas/AggregationGroupKeyV2" + metrics: + items: + $ref: "#/components/schemas/AggregationMetricResultV2" + type: array + AggregationMetricResultV2: type: object x-namespace: Ontologies - QueryType: - description: Represents a query type in the Ontology. properties: - apiName: - $ref: "#/components/schemas/QueryApiName" - description: + name: type: string x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - parameters: - additionalProperties: - $ref: "#/components/schemas/Parameter" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - output: - $ref: "#/components/schemas/OntologyDataType" - rid: - $ref: "#/components/schemas/FunctionRid" - version: - $ref: "#/components/schemas/FunctionVersion" + value: + description: | + The value of the metric. This will be a double in the case of + a numeric metric, or a date string in the case of a date metric. + x-safety: unsafe required: - - apiName - - rid - - version - type: object - x-namespace: Ontologies - QueryApiName: - description: | - The name of the Query in the API. + - name + AggregationGroupKeyV2: type: string + x-namespace: Ontologies + x-safety: unsafe + AggregationGroupValueV2: x-safety: unsafe x-namespace: Ontologies - ExecuteQueryRequest: - properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" + AggregationExactGroupingV2: + description: Divides objects into groups according to an exact value. type: object x-namespace: Ontologies - Attachment: + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + maxGroupCount: + type: integer + x-safety: safe + required: + - field + AggregationFixedWidthGroupingV2: + description: Divides objects into groups with the specified width. type: object x-namespace: Ontologies - description: The representation of an attachment. properties: - rid: - $ref: "#/components/schemas/AttachmentRid" - filename: - $ref: "#/components/schemas/Filename" - sizeBytes: - $ref: "#/components/schemas/SizeBytes" - mediaType: - $ref: "#/components/schemas/MediaType" + field: + $ref: "#/components/schemas/PropertyApiName" + fixedWidth: + type: integer + x-safety: safe required: - - rid - - filename - - sizeBytes - - mediaType - AttachmentProperty: + - field + - fixedWidth + AggregationRangeV2: + description: Specifies a range from an inclusive start value to an exclusive end value. type: object x-namespace: Ontologies - description: The representation of an attachment as a data type. properties: - rid: - $ref: "#/components/schemas/AttachmentRid" + startValue: + description: Inclusive start. + x-safety: unsafe + endValue: + description: Exclusive end. + x-safety: unsafe required: - - rid - AttachmentRid: - description: The unique resource identifier of an attachment. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - ActionRid: - description: The unique resource identifier for an action. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - AsyncApplyActionResponse: + - startValue + - endValue + AggregationRangesGroupingV2: + description: Divides objects into groups according to specified ranges. type: object x-namespace: Ontologies - AsyncActionOperation: - x-type: - type: asyncOperation - operationType: applyActionAsync - resultType: AsyncApplyActionResponse - stageType: AsyncActionStatus - x-namespace: Ontologies - AsyncActionStatus: - enum: - - RUNNING_SUBMISSION_CHECKS - - EXECUTING_WRITE_BACK_WEBHOOK - - COMPUTING_ONTOLOGY_EDITS - - COMPUTING_FUNCTION - - WRITING_ONTOLOGY_EDITS - - EXECUTING_SIDE_EFFECT_WEBHOOK - - SENDING_NOTIFICATIONS - x-namespace: Ontologies - QueryAggregation: + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + ranges: + items: + $ref: "#/components/schemas/AggregationRangeV2" + type: array + required: + - field + AggregationDurationGroupingV2: + description: | + Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. + When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. type: object + x-namespace: Ontologies properties: - key: - x-safety: unsafe + field: + $ref: "#/components/schemas/PropertyApiName" value: + type: integer x-safety: unsafe + unit: + $ref: "#/components/schemas/TimeUnit" required: - - key + - field - value - NestedQueryAggregation: + - unit + AggregationObjectTypeGrouping: + 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" + type: object + x-namespace: Ontologies + properties: {} + GeoJsonObject: + description: | + GeoJSon object + + The coordinate reference system for all GeoJSON coordinates is a + geographic coordinate reference system, using the World Geodetic System + 1984 (WGS 84) datum, with longitude and latitude units of decimal + degrees. + This is equivalent to the coordinate reference system identified by the + Open Geospatial Consortium (OGC) URN + An OPTIONAL third-position element SHALL be the height in meters above + or below the WGS 84 reference ellipsoid. + In the absence of elevation values, applications sensitive to height or + depth SHOULD interpret positions as being at local ground or sea level. + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3 + discriminator: + propertyName: type + mapping: + Feature: "#/components/schemas/Feature" + FeatureCollection: "#/components/schemas/FeatureCollection" + Point: "#/components/schemas/GeoPoint" + MultiPoint: "#/components/schemas/MultiPoint" + LineString: "#/components/schemas/LineString" + MultiLineString: "#/components/schemas/MultiLineString" + Polygon: "#/components/schemas/Polygon" + MultiPolygon: "#/components/schemas/MultiPolygon" + GeometryCollection: "#/components/schemas/GeometryCollection" + oneOf: + - $ref: "#/components/schemas/Feature" + - $ref: "#/components/schemas/FeatureCollection" + - $ref: "#/components/schemas/GeoPoint" + - $ref: "#/components/schemas/MultiPoint" + - $ref: "#/components/schemas/LineString" + - $ref: "#/components/schemas/MultiLineString" + - $ref: "#/components/schemas/Polygon" + - $ref: "#/components/schemas/MultiPolygon" + - $ref: "#/components/schemas/GeometryCollection" type: object properties: - key: + type: + type: string + enum: + - Feature + - FeatureCollection + - Point + - MultiPoint + - LineString + - MultiLineString + - Polygon + - MultiPolygon + - GeometryCollection + Geometry: + nullable: true + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1 + description: Abstract type for all GeoJSon object except Feature and FeatureCollection + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/GeoPoint" + MultiPoint: "#/components/schemas/MultiPoint" + LineString: "#/components/schemas/LineString" + MultiLineString: "#/components/schemas/MultiLineString" + Polygon: "#/components/schemas/Polygon" + MultiPolygon: "#/components/schemas/MultiPolygon" + GeometryCollection: "#/components/schemas/GeometryCollection" + oneOf: + - $ref: "#/components/schemas/GeoPoint" + - $ref: "#/components/schemas/MultiPoint" + - $ref: "#/components/schemas/LineString" + - $ref: "#/components/schemas/MultiLineString" + - $ref: "#/components/schemas/Polygon" + - $ref: "#/components/schemas/MultiPolygon" + - $ref: "#/components/schemas/GeometryCollection" + FeaturePropertyKey: + type: string + x-safety: unsafe + FeatureCollectionTypes: + discriminator: + propertyName: type + mapping: + Feature: "#/components/schemas/Feature" + oneOf: + - $ref: "#/components/schemas/Feature" + Feature: + type: object + description: GeoJSon 'Feature' object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.2 + properties: + geometry: + $ref: "#/components/schemas/Geometry" + properties: + description: | + A `Feature` object has a member with the name "properties". The + value of the properties member is an object (any JSON object or a + JSON null value). + additionalProperties: + x-safety: unsafe + x-mapKey: + $ref: "#/components/schemas/FeaturePropertyKey" + id: + description: | + If a `Feature` has a commonly used identifier, that identifier + SHOULD be included as a member of the Feature object with the name + "id", and the value of this member is either a JSON string or + number. x-safety: unsafe - groups: + bbox: + $ref: "#/components/schemas/BBox" + FeatureCollection: + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.3 + description: GeoJSon 'FeatureCollection' object + type: object + properties: + features: type: array items: - $ref: "#/components/schemas/QueryAggregation" + $ref: "#/components/schemas/FeatureCollectionTypes" + bbox: + $ref: "#/components/schemas/BBox" + GeoPoint: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 + type: object + properties: + coordinates: + $ref: "#/components/schemas/Position" + bbox: + $ref: "#/components/schemas/BBox" required: - - key - QueryAggregationRange: - description: Specifies a range from an inclusive start value to an exclusive end value. + - coordinates + MultiPoint: + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.3 type: object - x-namespace: Ontologies properties: - startValue: - description: Inclusive start. - x-safety: unsafe - endValue: - description: Exclusive end. - x-safety: unsafe - QueryTwoDimensionalAggregation: + coordinates: + type: array + items: + $ref: "#/components/schemas/Position" + bbox: + $ref: "#/components/schemas/BBox" + LineString: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 type: object properties: - groups: + coordinates: + $ref: "#/components/schemas/LineStringCoordinates" + bbox: + $ref: "#/components/schemas/BBox" + MultiLineString: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 + type: object + properties: + coordinates: type: array items: - $ref: "#/components/schemas/QueryAggregation" - QueryThreeDimensionalAggregation: + $ref: "#/components/schemas/LineStringCoordinates" + bbox: + $ref: "#/components/schemas/BBox" + Polygon: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 type: object properties: - groups: + coordinates: type: array items: - $ref: "#/components/schemas/NestedQueryAggregation" - ExecuteQueryResponse: + $ref: "#/components/schemas/LinearRing" + bbox: + $ref: "#/components/schemas/BBox" + MultiPolygon: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7 type: object properties: - value: - $ref: "#/components/schemas/DataValue" - required: - - value - x-namespace: Ontologies - FilterValue: + coordinates: + type: array + items: + type: array + items: + $ref: "#/components/schemas/LinearRing" + bbox: + $ref: "#/components/schemas/BBox" + LineStringCoordinates: + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.4 description: | - Represents the value of a property filter. For instance, false is the FilterValue in - `properties.{propertyApiName}.isNull=false`. - type: string - x-namespace: Ontologies - x-safety: unsafe - FunctionRid: + GeoJSon fundamental geometry construct, array of two or more positions. + type: array + items: + $ref: "#/components/schemas/Position" + minItems: 2 + LinearRing: + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.6 description: | - The unique resource identifier of a Function, useful for interacting with other Foundry APIs. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - FunctionVersion: - description: | - The version of the given Function, written `..-`, where `-` is optional. - Examples: `1.2.3`, `1.2.3-rc1`. - type: string - x-namespace: Ontologies - x-safety: unsafe - CustomTypeId: - description: | - A UUID representing a custom type in a given Function. - type: string - x-namespace: Ontologies - x-safety: safe - LinkTypeApiName: + A linear ring is a closed LineString with four or more positions. + + The first and last positions are equivalent, and they MUST contain + identical values; their representation SHOULD also be identical. + + A linear ring is the boundary of a surface or the boundary of a hole in + a surface. + + A linear ring MUST follow the right-hand rule with respect to the area + it bounds, i.e., exterior rings are counterclockwise, and holes are + clockwise. + type: array + items: + $ref: "#/components/schemas/Position" + minItems: 4 + GeometryCollection: + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.8 description: | - The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** - application. - type: string - x-namespace: Ontologies - x-safety: unsafe - ListActionTypesResponse: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/ActionType" - type: array + GeoJSon geometry collection + + GeometryCollections composed of a single part or a number of parts of a + single type SHOULD be avoided when that single part or a single object + of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could + be used instead. type: object - x-namespace: Ontologies - ListQueryTypesResponse: properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/QueryType" + geometries: type: array - type: object - x-namespace: Ontologies - ListLinkedObjectsResponse: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: items: - $ref: "#/components/schemas/OntologyObject" - type: array - type: object - x-namespace: Ontologies - ListObjectTypesResponse: + $ref: "#/components/schemas/Geometry" + minItems: 0 + bbox: + $ref: "#/components/schemas/BBox" + Position: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.1 + description: | + GeoJSon fundamental geometry construct. + + A position is an array of numbers. There MUST be two or more elements. + The first two elements are longitude and latitude, precisely in that order and using decimal numbers. + Altitude or elevation MAY be included as an optional third element. + + Implementations SHOULD NOT extend positions beyond three elements + because the semantics of extra elements are unspecified and ambiguous. + Historically, some implementations have used a fourth element to carry + a linear referencing measure (sometimes denoted as "M") or a numerical + timestamp, but in most situations a parser will not be able to properly + interpret these values. The interpretation and meaning of additional + elements is beyond the scope of this specification, and additional + elements MAY be ignored by parsers. + type: array + items: + $ref: "#/components/schemas/Coordinate" + minItems: 2 + maxItems: 3 + BBox: + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-5 + description: | + A GeoJSON object MAY have a member named "bbox" to include + information on the coordinate range for its Geometries, Features, or + FeatureCollections. The value of the bbox member MUST be an array of + length 2*n where n is the number of dimensions represented in the + contained geometries, with all axes of the most southwesterly point + followed by all axes of the more northeasterly point. The axes order + of a bbox follows the axes order of geometries. + type: array + items: + $ref: "#/components/schemas/Coordinate" + Coordinate: + type: number + format: double + x-safety: unsafe + InvalidApplyActionOptionCombination: + description: The given options are individually valid but cannot be used in the given combination. properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of object types in the current page. - items: - $ref: "#/components/schemas/ObjectType" - type: array - type: object - x-namespace: Ontologies - ListObjectsResponse: + parameters: + properties: + invalidCombination: + $ref: "#/components/schemas/ApplyActionRequestOptions" + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + ActionContainsDuplicateEdits: + description: The given action request has multiple edits on the same object. properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of objects in the current page. - items: - $ref: "#/components/schemas/OntologyObject" - type: array - totalCount: - $ref: "#/components/schemas/TotalCount" - required: - - totalCount - type: object - x-namespace: Ontologies - ListOntologiesResponse: + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + ActionEditsReadOnlyEntity: + description: The given action request performs edits on a type that is read-only or does not allow edits. properties: - data: - description: The list of Ontologies the user has access to. - items: - $ref: "#/components/schemas/Ontology" - type: array - type: object - x-namespace: Ontologies - ListOutgoingLinkTypesResponse: + parameters: + type: object + properties: + entityTypeRid: + $ref: "#/components/schemas/ObjectTypeRid" + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + ObjectSetNotFound: + description: "The requested object set is not found, or the client token does not have access to it." properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of link type sides in the current page. - items: - $ref: "#/components/schemas/LinkTypeSide" - type: array - type: object + parameters: + properties: + objectSetRid: + $ref: "#/components/schemas/ObjectSetRid" + required: + - objectSetRid + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectRid: + MarketplaceInstallationNotFound: description: | - The unique resource identifier of an object, useful for interacting with other Foundry APIs. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - ObjectType: - description: Represents an object type in the Ontology. + The given marketplace installation could not be found or the user does not have access to it. properties: - apiName: - $ref: "#/components/schemas/ObjectTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - description: - description: The description of the object type. + parameters: + properties: + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" + required: + - artifactRepository + - packageName + type: object + errorCode: + enum: + - NOT_FOUND type: string - x-safety: unsafe - visibility: - $ref: "#/components/schemas/ObjectTypeVisibility" - primaryKey: - description: The primary key of the object. This is a list of properties that can be used to uniquely identify the object. - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - properties: - description: A map of the properties of the object type. - additionalProperties: - $ref: "#/components/schemas/Property" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - rid: - $ref: "#/components/schemas/ObjectTypeRid" - required: - - apiName - - status - - rid - type: object - x-namespace: Ontologies - ObjectTypeApiName: - description: | - The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the - `List object types` endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - ObjectTypeVisibility: - enum: - - NORMAL - - PROMINENT - - HIDDEN - description: The suggested visibility of the object type. + errorName: + type: string + errorInstanceId: + type: string + x-type: error + MarketplaceObjectMappingNotFound: + description: The given object could not be mapped to a Marketplace installation. + properties: + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" + required: + - objectType + - artifactRepository + - packageName + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + MarketplaceActionMappingNotFound: + description: The given action could not be mapped to a Marketplace installation. + properties: + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" + required: + - actionType + - artifactRepository + - packageName + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + MarketplaceQueryMappingNotFound: + description: The given query could not be mapped to a Marketplace installation. + properties: + parameters: + properties: + queryType: + $ref: "#/components/schemas/QueryApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" + required: + - queryType + - artifactRepository + - packageName + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + MarketplaceLinkMappingNotFound: + description: The given link could not be mapped to a Marketplace installation. + properties: + parameters: + properties: + linkType: + $ref: "#/components/schemas/LinkTypeApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" + required: + - linkType + - artifactRepository + - packageName + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + OntologyApiNameNotUnique: + description: The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name. + properties: + parameters: + properties: + ontologyApiName: + $ref: "#/components/schemas/OntologyApiName" + type: object + required: + - ontologyApiName + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + RequestId: type: string + format: uuid + description: Unique request id x-namespace: Ontologies - ObjectTypeRid: - description: "The unique resource identifier of an object type, useful for interacting with other Foundry APIs." - format: rid + x-safety: safe + SubscriptionId: type: string + format: uuid + description: A unique identifier used to associate subscription requests with responses. x-namespace: Ontologies x-safety: safe - Ontology: - description: Metadata about an Ontology. + ObjectSetStreamSubscribeRequest: + type: object properties: - apiName: - $ref: "#/components/schemas/OntologyApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - type: string - x-safety: unsafe - rid: - $ref: "#/components/schemas/OntologyRid" + objectSet: + $ref: "#/components/schemas/ObjectSet" + propertySet: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + referenceSet: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" required: - - apiName - - displayName - - description - - rid - type: object + - objectSet x-namespace: Ontologies - OntologyObject: - description: Represents an object in the Ontology. + ObjectSetStreamSubscribeRequests: + type: object + 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" properties: - properties: - description: A map of the property values of the object. - nullable: true - additionalProperties: - $ref: "#/components/schemas/PropertyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - rid: - $ref: "#/components/schemas/ObjectRid" + id: + description: "A randomly generated RequestId used to associate a ObjectSetStreamSubscribeRequest with a subsequent \nObjectSetSubscribeResponses. Each RequestId should be unique.\n" + $ref: "#/components/schemas/RequestId" + requests: + type: array + items: + $ref: "#/components/schemas/ObjectSetStreamSubscribeRequest" required: - - rid + - id + x-namespace: Ontologies + StreamMessage: type: object + discriminator: + propertyName: type + mapping: + subscribeResponses: "#/components/schemas/ObjectSetSubscribeResponses" + objectSetChanged: "#/components/schemas/ObjectSetUpdates" + refreshObjectSet: "#/components/schemas/RefreshObjectSet" + subscriptionClosed: "#/components/schemas/SubscriptionClosed" + oneOf: + - $ref: "#/components/schemas/ObjectSetSubscribeResponses" + - $ref: "#/components/schemas/ObjectSetUpdates" + - $ref: "#/components/schemas/RefreshObjectSet" + - $ref: "#/components/schemas/SubscriptionClosed" x-namespace: Ontologies - OntologyRid: + ObjectSetSubscribeResponses: + type: object description: | - The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the - `List ontologies` endpoint or check the **Ontology Manager**. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - OntologyApiName: - type: string - x-namespace: Ontologies - x-safety: unsafe - OrderBy: - 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" - type: string - x-namespace: Ontologies - x-safety: unsafe - Parameter: - description: Details about a parameter of an action or query. + Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. properties: - description: - type: string - x-safety: unsafe - baseType: - $ref: "#/components/schemas/ValueType" - dataType: - $ref: "#/components/schemas/OntologyDataType" - required: - type: boolean - x-safety: safe + responses: + type: array + items: + $ref: "#/components/schemas/ObjectSetSubscribeResponse" + id: + $ref: "#/components/schemas/RequestId" required: - - baseType - - required - type: object - x-namespace: Ontologies - ParameterId: - description: | - The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. - Parameters can be viewed and managed in the **Ontology Manager**. - type: string + - id x-namespace: Ontologies - x-safety: unsafe - DataValue: - description: | - Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. - | Type | JSON encoding | Example | - |-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| - | Array | array | `["alpha", "bravo", "charlie"]` | - | Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | - | Boolean | boolean | `true` | - | Byte | number | `31` | - | Date | ISO 8601 extended local date string | `"2021-05-01"` | - | Decimal | string | `"2.718281828"` | - | Float | number | `3.14159265` | - | Double | number | `3.14159265` | - | Integer | number | `238940` | - | Long | string | `"58319870951433"` | - | Marking | string | `"MU"` | - | Null | null | `null` | - | Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| - | Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | - | Set | array | `["alpha", "bravo", "charlie"]` | - | Short | number | `8739` | - | String | string | `"Call me Ishmael"` | - | Struct | JSON object | `{"name": "John Doe", "age": 42}` | - | TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | - | ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| - | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - x-safety: unsafe - PrimaryKeyValue: - description: Represents the primary key value that is used as a unique identifier for an object. - x-safety: unsafe + ObjectSetSubscribeResponse: + type: object + discriminator: + propertyName: type + mapping: + success: "#/components/schemas/SubscriptionSuccess" + error: "#/components/schemas/SubscriptionError" + qos: "#/components/schemas/QosError" + oneOf: + - $ref: "#/components/schemas/SubscriptionSuccess" + - $ref: "#/components/schemas/SubscriptionError" + - $ref: "#/components/schemas/QosError" x-namespace: Ontologies - Property: - description: Details about some property of an object. + SubscriptionSuccess: + type: object properties: - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - baseType: - $ref: "#/components/schemas/ValueType" + id: + $ref: "#/components/schemas/SubscriptionId" required: - - baseType + - id + x-namespace: Ontologies + SubscriptionError: type: object + properties: + errors: + type: array + items: + $ref: "#/components/schemas/Error" x-namespace: Ontologies - PropertyApiName: + QosError: + type: object description: | - The name of the property in the API. To find the API name for your property, use the `Get object type` - endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - FieldNameV1: - description: "A reference to an Ontology object property with the form `properties.{propertyApiName}`." - type: string + An error indicating that the subscribe request should be attempted on a different node. x-namespace: Ontologies - x-safety: unsafe - PropertyFilter: - description: | - Represents a filter used on properties. - - Endpoints that accept this supports optional parameters that have the form: - `properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. - For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called - "firstName" that has the exact value of "John". - - The following are a list of supported property filters: - - - `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties - that have at least one of the provided values. If multiple query parameters are provided, then objects - that have any of the given values for the specified property will be matched. - - `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided - property. If multiple query parameters are provided, then objects that have any of the given values - will be matched. For instance, if the user provides a request by doing - `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property - of either John or Anna will be matched. This filter is supported on all property types except Arrays. - - `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. - Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values - will be excluded from the result. - - `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` - `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater - than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. - - `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. - This filter is supported on all property types. + ErrorName: type: string - x-namespace: Ontologies x-safety: safe - PropertyId: - description: | - The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** - application and assign them API names. In every other case, API names should be used instead of property IDs. - type: string - x-namespace: Ontologies - x-safety: unsafe - SelectedPropertyApiName: - description: | - By default, anytime an object is requested, every property belonging to that object is returned. - The response can be filtered to only include certain properties using the `properties` query parameter. - - Properties to include can be specified in one of two ways. - - - A comma delimited list as the value for the `properties` query parameter - `properties={property1ApiName},{property2ApiName}` - - Multiple `properties` query parameters. - `properties={property1ApiName}&properties={property2ApiName}` - - The primary key of the object will always be returned even if it wasn't specified in the `properties` values. - - Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. - - To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - PropertyValue: - description: | - Represents the value of a property in the following format. - - | Type | JSON encoding | Example | - |----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| - | Array | array | `["alpha", "bravo", "charlie"]` | - | Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | - | Boolean | boolean | `true` | - | Byte | number | `31` | - | Date | ISO 8601 extended local date string | `"2021-05-01"` | - | Decimal | string | `"2.718281828"` | - | Double | number | `3.14159265` | - | Float | number | `3.14159265` | - | GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | - | GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | - | Integer | number | `238940` | - | Long | string | `"58319870951433"` | - | Short | number | `8739` | - | String | string | `"Call me Ishmael"` | - | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - - Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. - x-safety: unsafe - x-namespace: Ontologies - PropertyValueEscapedString: - description: Represents the value of a property in string format. This is used in URL parameters. - type: string x-namespace: Ontologies - x-safety: unsafe - LinkTypeSide: + Arg: type: object - x-namespace: Ontologies properties: - apiName: - $ref: "#/components/schemas/LinkTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - cardinality: - $ref: "#/components/schemas/LinkTypeSideCardinality" - foreignKeyPropertyApiName: - $ref: "#/components/schemas/PropertyApiName" + name: + type: string + x-safety: safe + value: + type: string + x-safety: unsafe required: - - apiName - - displayName - - status - - objectTypeApiName - - cardinality - LinkTypeSideCardinality: - enum: - - ONE - - MANY + - name + - value x-namespace: Ontologies - AggregateObjectsRequest: + Error: type: object - x-namespace: Ontologies properties: - aggregation: - items: - $ref: "#/components/schemas/Aggregation" - type: array - query: - $ref: "#/components/schemas/SearchJsonQuery" - groupBy: - items: - $ref: "#/components/schemas/AggregationGroupBy" + error: + $ref: "#/components/schemas/ErrorName" + args: type: array - AggregateObjectsResponse: - properties: - excludedItems: - type: integer - x-safety: unsafe - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: items: - $ref: "#/components/schemas/AggregateObjectsResponseItem" - type: array - type: object + $ref: "#/components/schemas/Arg" + required: + - error x-namespace: Ontologies - AggregateObjectsResponseItem: - type: object + ReasonType: + description: | + Represents the reason a subscription was closed. + enum: + - USER_CLOSED + - CHANNEL_CLOSED x-namespace: Ontologies + Reason: + type: object properties: - group: - additionalProperties: - $ref: "#/components/schemas/AggregationGroupValue" - x-mapKey: - $ref: "#/components/schemas/AggregationGroupKey" - metrics: - items: - $ref: "#/components/schemas/AggregationMetricResult" - type: array - AggregationGroupKey: - type: string - x-namespace: Ontologies - x-safety: unsafe - AggregationGroupValue: - x-safety: unsafe + reason: + $ref: "#/components/schemas/ReasonType" + required: + - reason x-namespace: Ontologies - AggregationMetricResult: + SubscriptionClosureCause: type: object + discriminator: + propertyName: type + mapping: + error: "#/components/schemas/Error" + reason: "#/components/schemas/Reason" + oneOf: + - $ref: "#/components/schemas/Error" + - $ref: "#/components/schemas/Reason" x-namespace: Ontologies - properties: - name: - type: string - x-safety: unsafe - value: - type: number - format: double - description: TBD - x-safety: unsafe - required: - - name - SearchObjectsRequest: - properties: - query: - $ref: "#/components/schemas/SearchJsonQuery" - orderBy: - $ref: "#/components/schemas/SearchOrderBy" - pageSize: - $ref: "#/components/schemas/PageSize" - pageToken: - $ref: "#/components/schemas/PageToken" - fields: - description: | - The API names of the object type properties to include in the response. - type: array - items: - $ref: "#/components/schemas/PropertyApiName" - required: - - query + RefreshObjectSet: type: object - x-namespace: Ontologies - SearchObjectsResponse: + description: | + The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. properties: - data: - items: - $ref: "#/components/schemas/OntologyObject" - type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - totalCount: - $ref: "#/components/schemas/TotalCount" + id: + $ref: "#/components/schemas/SubscriptionId" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - totalCount - type: object - x-namespace: Ontologies - ValidateActionRequest: - properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - type: object + - id + - objectType x-namespace: Ontologies - ValidateActionResponse: + SubscriptionClosed: type: object - x-namespace: Ontologies + description: | + The subscription has been closed due to an irrecoverable error during its lifecycle. properties: - result: - $ref: "#/components/schemas/ValidationResult" - submissionCriteria: - items: - $ref: "#/components/schemas/SubmissionCriteriaEvaluation" - type: array - parameters: - additionalProperties: - $ref: "#/components/schemas/ParameterEvaluationResult" - x-mapKey: - $ref: "#/components/schemas/ParameterId" + id: + $ref: "#/components/schemas/SubscriptionId" + cause: + $ref: "#/components/schemas/SubscriptionClosureCause" required: - - result - SubmissionCriteriaEvaluation: - description: | - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - type: object + - id + - cause x-namespace: Ontologies + ObjectSetUpdates: + type: object properties: - configuredFailureMessage: - description: | - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - type: string - x-safety: unsafe - result: - $ref: "#/components/schemas/ValidationResult" + id: + $ref: "#/components/schemas/SubscriptionId" + updates: + type: array + items: + $ref: "#/components/schemas/ObjectSetUpdate" required: - - result - ValidationResult: - description: | - Represents the state of a validation. - enum: - - VALID - - INVALID - type: string + - id x-namespace: Ontologies - SearchJsonQuery: + ObjectSetUpdate: type: object - x-namespace: Ontologies discriminator: propertyName: type mapping: - lt: "#/components/schemas/LtQuery" - gt: "#/components/schemas/GtQuery" - lte: "#/components/schemas/LteQuery" - gte: "#/components/schemas/GteQuery" - eq: "#/components/schemas/EqualsQuery" - isNull: "#/components/schemas/IsNullQuery" - contains: "#/components/schemas/ContainsQuery" - and: "#/components/schemas/AndQuery" - or: "#/components/schemas/OrQuery" - not: "#/components/schemas/NotQuery" - prefix: "#/components/schemas/PrefixQuery" - phrase: "#/components/schemas/PhraseQuery" - anyTerm: "#/components/schemas/AnyTermQuery" - allTerms: "#/components/schemas/AllTermsQuery" + object: "#/components/schemas/ObjectUpdate" + reference: "#/components/schemas/ReferenceUpdate" oneOf: - - $ref: "#/components/schemas/LtQuery" - - $ref: "#/components/schemas/GtQuery" - - $ref: "#/components/schemas/LteQuery" - - $ref: "#/components/schemas/GteQuery" - - $ref: "#/components/schemas/EqualsQuery" - - $ref: "#/components/schemas/IsNullQuery" - - $ref: "#/components/schemas/ContainsQuery" - - $ref: "#/components/schemas/AndQuery" - - $ref: "#/components/schemas/OrQuery" - - $ref: "#/components/schemas/NotQuery" - - $ref: "#/components/schemas/PrefixQuery" - - $ref: "#/components/schemas/PhraseQuery" - - $ref: "#/components/schemas/AnyTermQuery" - - $ref: "#/components/schemas/AllTermsQuery" - LtQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is less than a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - GtQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is greater than a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - LteQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is less than or equal to a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - GteQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is greater than or equal to a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - EqualsQuery: - type: object + - $ref: "#/components/schemas/ObjectUpdate" + - $ref: "#/components/schemas/ReferenceUpdate" x-namespace: Ontologies - description: Returns objects where the specified field is equal to a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - IsNullQuery: - type: object + ObjectState: + 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" + enum: + - ADDED_OR_UPDATED + - REMOVED x-namespace: Ontologies - description: Returns objects based on the existence of the specified field. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: boolean - x-safety: unsafe - required: - - field - - value - ContainsQuery: + ObjectUpdate: type: object - x-namespace: Ontologies - description: Returns objects where the specified array contains a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - AndQuery: - type: object - x-namespace: Ontologies - description: Returns objects where every query is satisfied. - properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQuery" - type: array - OrQuery: - type: object - x-namespace: Ontologies - description: Returns objects where at least 1 query is satisfied. - properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQuery" - type: array - NotQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the query is not satisfied. - properties: - value: - $ref: "#/components/schemas/SearchJsonQuery" - required: - - value - PrefixQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field starts with the provided value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string - x-safety: unsafe - required: - - field - - value - PhraseQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field contains the provided value as a substring. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string - x-safety: unsafe - required: - - field - - value - AnyTermQuery: - type: object - x-namespace: Ontologies - 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" - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/Fuzzy" - required: - - field - - value - AllTermsQuery: - type: object - x-namespace: Ontologies - description: | - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/Fuzzy" - required: - - field - - value - Fuzzy: - description: Setting fuzzy to `true` allows approximate matching in search queries that support it. - type: boolean - x-namespace: Ontologies - x-safety: safe - SearchOrderBy: - description: Specifies the ordering of search results by a field and an ordering direction. - type: object - x-namespace: Ontologies - properties: - fields: - items: - $ref: "#/components/schemas/SearchOrdering" - type: array - SearchOrdering: - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - direction: - description: Specifies the ordering direction (can be either `asc` or `desc`) - type: string - x-safety: safe - required: - - field - ResourcePath: - description: | - A path in the Foundry file tree. - type: string - x-safety: unsafe - x-namespace: Datasets - DatasetName: - type: string - x-safety: unsafe - x-namespace: Datasets - DatasetRid: - description: | - The Resource Identifier (RID) of a Dataset. Example: `ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`. - format: rid - type: string - x-safety: safe - Dataset: - properties: - rid: - $ref: "#/components/schemas/DatasetRid" - name: - $ref: "#/components/schemas/DatasetName" - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - required: - - rid - - name - - parentFolderRid - type: object - x-namespace: Datasets - CreateDatasetRequest: - properties: - name: - $ref: "#/components/schemas/DatasetName" - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - required: - - name - - parentFolderRid - type: object - x-namespace: Datasets - TableExportFormat: - description: | - Format for tabular dataset export. - enum: - - ARROW - - CSV - x-namespace: Datasets - BranchId: - description: | - The identifier (name) of a Branch. Example: `master`. - type: string - x-safety: unsafe - Branch: - description: | - A Branch of a Dataset. - properties: - branchId: - $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - branchId - type: object - x-namespace: Datasets - CreateBranchRequest: - properties: - branchId: - $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - branchId - type: object - x-namespace: Datasets - ListBranchesResponse: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of branches in the current page. - items: - $ref: "#/components/schemas/Branch" - type: array - type: object - x-namespace: Datasets - TransactionRid: - description: | - The Resource Identifier (RID) of a Transaction. Example: `ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4`. - format: rid - type: string - x-safety: safe - x-namespace: Datasets - TransactionType: - description: | - The type of a Transaction. - enum: - - APPEND - - UPDATE - - SNAPSHOT - - DELETE - x-namespace: Datasets - TransactionStatus: - description: | - The status of a Transaction. - enum: - - ABORTED - - COMMITTED - - OPEN - x-namespace: Datasets - CreateTransactionRequest: - properties: - transactionType: - $ref: "#/components/schemas/TransactionType" - type: object - x-namespace: Datasets - Transaction: - description: | - An operation that modifies the files within a dataset. - properties: - rid: - $ref: "#/components/schemas/TransactionRid" - transactionType: - $ref: "#/components/schemas/TransactionType" - status: - $ref: "#/components/schemas/TransactionStatus" - createdTime: - type: string - format: date-time - description: "The timestamp when the transaction was created, in ISO 8601 timestamp format." - x-safety: unsafe - closedTime: - type: string - format: date-time - description: "The timestamp when the transaction was closed, in ISO 8601 timestamp format." - x-safety: unsafe - required: - - rid - - transactionType - - status - - createdTime - type: object - x-namespace: Datasets - File: - properties: - path: - $ref: "#/components/schemas/FilePath" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - sizeBytes: - type: string - format: long - x-safety: safe - updatedTime: - type: string - format: date-time - x-safety: unsafe - required: - - path - - transactionRid - - updatedTime - type: object - x-namespace: Datasets - ListFilesResponse: - description: A page of Files and an optional page token that can be used to retrieve the next page. - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/File" - type: array - type: object - x-namespace: Datasets - OperationNotFound: - description: "The operation is not found, or the user does not have access to it." - properties: - parameters: - type: object - properties: - id: - type: string - format: rid - x-safety: safe - required: - - id - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Operations - ParameterKey: - description: | - The unique identifier of the model parameter. - type: string - x-namespace: Models - x-safety: unsafe - ParameterValue: - x-safety: unsafe - x-namespace: Models - ChatMessage: - type: object - properties: - role: - $ref: "#/components/schemas/ChatMessageRole" - content: - type: string - x-safety: unsafe - x-namespace: Models - required: - - role - ChatMessageRole: - enum: - - SYSTEM - - ASSISTANT - - USER - x-namespace: Models - ChatCompletionRequest: - type: object - properties: - messages: - type: array - items: - $ref: "#/components/schemas/ChatMessage" - parameters: - description: | - Any additional model-specific parameters: - - for global models, the keys can be one of the following - (refer to https://platform.openai.com/docs/api-reference/chat/create for documentation on these parameters): - - `temperature` - - `top_p` - - `n` - - `stop` - - `max_tokens` - - `presence_penalty` - - `frequency_penalty` - - `logit_bias` - additionalProperties: - $ref: "#/components/schemas/ParameterValue" - x-mapKey: - $ref: "#/components/schemas/ParameterKey" - x-namespace: Models - ChatCompletionChoice: - type: object - properties: - message: - $ref: "#/components/schemas/ChatMessage" - x-namespace: Models - ChatCompletionResponse: - description: Contains `n` different completion choices as specified in the request parameter. - type: object - properties: - choices: - type: array - items: - $ref: "#/components/schemas/ChatCompletionChoice" - x-namespace: Models - LanguageModelSource: - enum: - - global - - hosted - ListLanguageModelsResponse: - properties: - data: - description: The list of language models. - items: - $ref: "#/components/schemas/LanguageModel" - type: array - type: object - x-namespace: Models - LanguageModel: - description: Represents a language model. - properties: - apiName: - $ref: "#/components/schemas/LanguageModelApiName" - source: - $ref: "#/components/schemas/LanguageModelSource" - type: object - x-namespace: Models - LanguageModelApiName: - description: | - The name of the language model in the API. To find the API name for your model, use the `List language models` - endpoint. - type: string - x-namespace: Models - x-safety: unsafe -paths: - /api/v2/ontologies: - get: - description: | - Lists the Ontologies visible to the current user. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listOntologiesV2 - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/ListOntologiesV2Response" - 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 - description: Success response. - /api/v2/ontologies/{ontology}: - get: - description: | - Gets a specific ontology with the given Ontology RID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getOntologyV2 - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/OntologyV2" - example: - apiName: default-ontology - displayName: Ontology - description: The default ontology - rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: Success response. - /api/v2/ontologies/{ontology}/fullMetadata: - get: - description: | - Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. - operationId: getOntologyFullMetadata - x-operationVerb: getFullMetadata - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/OntologyFullMetadata" - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}: - get: - description: | - Lists the objects for the given Ontology and object type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjectsV2 - x-operationVerb: list - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The desired size of the page to be returned. Defaults to 1,000. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false - schema: - $ref: "#/components/schemas/PageToken" - - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: select - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy - required: false - schema: - $ref: "#/components/schemas/OrderBy" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - 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" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/ListObjectsResponseV2" - example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - 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 - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}: - get: - description: | - Gets a specific object with the given primary key. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectV2 - x-operationVerb: get - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the requested object. To look up the expected primary key for your object type, use the - `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: select - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - 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" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/OntologyObjectV2" - example: - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - __primaryKey: 50030 - __apiName: Employee - id: 50030 - firstName: John - lastName: Doe - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/count: - post: - description: | - Returns a count of the objects of the given object type. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: countObjects - x-operationVerb: count - x-auditCategory: ontologyDataSearch - x-releaseStage: PRIVATE_BETA - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/CountObjectsResponseV2" - example: - count: 100 - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/search: - post: - 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| startsWith | The provided property starts with the provided value. | 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 value 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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: searchObjectsV2 - x-operationVerb: search - x-auditCategory: ontologyDataSearch - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: + properties: + object: + $ref: "#/components/schemas/OntologyObjectV2" + state: + $ref: "#/components/schemas/ObjectState" + required: + - object + - state + x-namespace: Ontologies + ObjectPrimaryKey: + type: object + additionalProperties: + $ref: "#/components/schemas/PropertyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + x-namespace: Ontologies + ReferenceUpdate: + type: object + description: | + The updated data value associated with an object instance's external reference. The object instance + is uniquely identified by an object type and a primary key. Note that the value of the property + field returns a dereferenced value rather than the reference itself. + properties: + objectType: $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsRequestV2" - example: - where: - type: eq - field: age - value: 21 - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsResponseV2" - 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 - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/aggregate: - post: + primaryKey: + $ref: "#/components/schemas/ObjectPrimaryKey" + description: The ObjectPrimaryKey of the object instance supplying the reference property. + property: + $ref: "#/components/schemas/PropertyApiName" + description: The PropertyApiName on the object type that corresponds to the reference property + value: + $ref: "#/components/schemas/ReferenceValue" + required: + - objectType + - primaryKey + - property + - value + x-namespace: Ontologies + ReferenceValue: + type: object + description: Resolved data values pointed to by a reference. + discriminator: + propertyName: type + mapping: + geotimeSeriesValue: "#/components/schemas/GeotimeSeriesValue" + oneOf: + - $ref: "#/components/schemas/GeotimeSeriesValue" + x-namespace: Ontologies + GeotimeSeriesValue: + type: object + description: The underlying data values pointed to by a GeotimeSeriesReference. + properties: + position: + $ref: "#/components/schemas/Position" + timestamp: + type: string + format: date-time + x-safety: unsafe + required: + - position + - timestamp + x-namespace: Ontologies +paths: + /v2/operations/{operationId}: + get: description: | - Perform functions on object fields in the specified ontology and object type. + Get an asynchronous operation by its ID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: aggregateObjectsV2 - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch - x-releaseStage: STABLE + operationId: getOperation + x-operationVerb: get + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: The type of the object to aggregate on. + - description: "The unique Resource Identifier (RID) of the operation. \nThis is the id returned in the response of the invoking operation.\n" in: path - name: objectType + name: operationId required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsRequestV2" - example: - aggregation: - - type: min - field: properties.tenure - name: min_tenure - - type: avg - field: properties.tenure - name: avg_tenure - query: - not: - field: name - eq: john - groupBy: - - field: startDate - type: range - ranges: - - startValue: 2020-01-01 - endValue: 2020-06-01 - - field: city - type: exact + type: string + format: rid + x-safety: safe + example: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectsResponseV2" - 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 + x-type: + type: asyncOperationCollection description: Success response. - /api/v2/ontologies/{ontology}/interfaceTypes: + /api/v1/ontologies: get: - description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nLists 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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: listInterfaceTypes + description: | + Lists the Ontologies visible to the current user. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listOntologies x-operationVerb: list x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The desired size of the page to be returned. Defaults to 500. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false - schema: - $ref: "#/components/schemas/PageToken" - - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" responses: "200": content: application/json: - schema: - $ref: "#/components/schemas/ListInterfaceTypesResponse" - example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - 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 + schema: + $ref: "#/components/schemas/ListOntologiesResponse" + 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 description: Success response. - /api/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}: + /api/v1/ontologies/{ontologyRid}: get: description: | - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Gets a specific object type with the given API name. + Gets a specific ontology with the given Ontology RID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getInterfaceType + operationId: getOntology x-operationVerb: get x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the interface type. To find the API name, use the **List interface types** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: interfaceType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/InterfaceTypeApiName" - example: Employee - - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/InterfaceType" + $ref: "#/components/schemas/Ontology" 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 + apiName: default-ontology + displayName: Ontology + description: The default ontology + rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/search: - post: - description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\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 value. | 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 value 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\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" - operationId: searchObjectsForInterface + /api/v1/ontologies/{ontologyRid}/objectTypes: + get: + description: | + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listObjectTypes x-operationVerb: list - x-auditCategory: ontologyDataSearch - x-releaseStage: PRIVATE_BETA + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the interface type. To find the API name, use the **List interface types** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: interfaceType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/InterfaceTypeApiName" - example: Employee + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. + The desired size of the page to be returned. Defaults to 500. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query - name: preview + name: pageSize required: false schema: - $ref: "#/components/schemas/PreviewMode" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsForInterfaceRequest" + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SearchObjectsResponseV2" + $ref: "#/components/schemas/ListObjectTypesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb - __primaryKey: 1000 - __apiName: Employee - employeeId: 1000 - lastName: smith - firstName: john - age: 21 + - 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 description: Success response. - /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate: - post: - description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: aggregateObjectsForInterface - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch - x-releaseStage: PRIVATE_BETA + /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}: + get: + description: | + Gets a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectType + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the interface type. To find the API name, use the **List interface types** endpoint or + The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. in: path - name: interfaceType + name: objectType required: true schema: - $ref: "#/components/schemas/InterfaceTypeApiName" - example: Employee - - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsRequestV2" - example: - aggregation: - - type: min - field: properties.tenure - name: min_tenure - - type: avg - field: properties.tenure - name: avg_tenure - query: - not: - field: name - eq: john - groupBy: - - field: startDate - type: range - ranges: - - startValue: 2020-01-01 - endValue: 2020-06-01 - - field: city - type: exact + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee responses: "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsResponseV2" - 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 + content: + application/json: + schema: + $ref: "#/components/schemas/ObjectType" + 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 description: Success response. - /api/v2/ontologies/{ontology}/queryTypes: + /api/v1/ontologies/{ontologyRid}/actionTypes: get: - 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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: listQueryTypesV2 + description: | + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listActionTypes x-operationVerb: list x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -8421,16 +7764,16 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The desired size of the page to be returned. Defaults to 100. + The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -8447,57 +7790,40 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListQueryTypesResponseV2" + $ref: "#/components/schemas/ListActionTypesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: getEmployeesInCity - displayName: Get Employees in City - description: Gets all employees in a given city + - apiName: promote-employee + description: Update an employee's title and compensation 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 + 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: - 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 + 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 description: Success response. - /api/v2/ontologies/{ontology}/queryTypes/{queryApiName}: + /api/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}: get: description: | - Gets a specific query type with the given API name. + Gets a specific action type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getQueryTypeV2 + operationId: getActionType x-operationVerb: get x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -8507,54 +7833,143 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action type. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the query type. To find the API name, use the **List query types** endpoint or - check the **Ontology Manager**. + The name of the action type in the API. in: path - name: queryApiName + name: actionTypeApiName required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity + $ref: "#/components/schemas/ActionTypeApiName" + example: promote-employee responses: "200": content: application/json: schema: - $ref: "#/components/schemas/QueryTypeV2" + $ref: "#/components/schemas/ActionType" 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 + 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 description: Success response. - /api/v2/ontologies/{ontology}/queries/{queryApiName}/execute: - post: - description: "Executes a Query using the given parameters.\n\nOptional parameters do not need to be supplied.\n\nThird-party applications using this endpoint via OAuth2 must request the \nfollowing operation scopes: `api:ontologies-read`.\n" - operationId: executeQueryV2 - x-operationVerb: execute + /api/v1/ontologies/{ontologyRid}/objects/{objectType}: + get: + description: | + Lists the objects for the given Ontology and object type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listObjects + x-operationVerb: list + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: | + The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. + in: path + name: ontologyRid + required: true + schema: + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The desired size of the page to be returned. Defaults to 1,000. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false + schema: + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: properties + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - in: query + name: orderBy + required: false + schema: + $ref: "#/components/schemas/OrderBy" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ListObjectsResponse" + example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + 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 + description: Success response. + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}: + get: + description: | + Gets a specific object with the given primary key. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObject + x-operationVerb: get x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: @@ -8563,61 +7978,62 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the Query to execute. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: queryApiName + name: objectType required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false + The primary key of the requested object. To look up the expected primary key for your object type, use the + `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - The package name of the generated SDK. + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. in: query - name: packageName - required: false + name: properties schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ExecuteQueryRequest" - example: - parameters: - city: New York + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ExecuteQueryResponse" + $ref: "#/components/schemas/OntologyObject" example: - value: - - EMP546 - - EMP609 - - EMP989 + rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + properties: + id: 50030 + firstName: John + lastName: Doe description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}: get: description: | Lists the linked objects for a specific object and the given link type. + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or repeated objects in the response pages. @@ -8631,7 +8047,7 @@ paths: Note that null value properties will not be returned. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listLinkedObjectsV2 + operationId: listLinkedObjects x-operationVerb: listLinkedObjects x-auditCategory: ontologyDataLoad x-releaseStage: STABLE @@ -8641,16 +8057,16 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + 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**. in: path name: objectType @@ -8693,7 +8109,7 @@ paths: The properties of the object type that should be included in the response. Omit this parameter to get all the properties. in: query - name: select + name: properties schema: type: array items: @@ -8703,57 +8119,34 @@ paths: required: false schema: $ref: "#/components/schemas/OrderBy" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - 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" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListLinkedObjectsResponseV2" + $ref: "#/components/schemas/ListLinkedObjectsResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 + - 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 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: get: description: | - Get a specific linked object that originates from another object. - - If there is no link between the two objects, `LinkedObjectNotFound` is thrown. + Get a specific linked object that originates from another object. If there is no link between the two objects, + LinkedObjectNotFound is thrown. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getLinkedObjectV2 + operationId: getLinkedObject x-operationVerb: getLinkedObject x-auditCategory: ontologyDataLoad x-releaseStage: STABLE @@ -8763,17 +8156,15 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - 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**." in: path name: objectType required: true @@ -8781,7 +8172,7 @@ paths: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - description: | - The primary key of the object from which the links originate. To look up the expected primary key for your + The primary key of the object from which the link originates. To look up the expected primary key for your object type, use the `Get object type` endpoint or the **Ontology Manager**. in: path name: primaryKey @@ -8811,133 +8202,279 @@ paths: The properties of the object type that should be included in the response. Omit this parameter to get all the properties. in: query - name: select + name: properties schema: type: array items: $ref: "#/components/schemas/SelectedPropertyApiName" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/OntologyObject" + example: + rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 + properties: + id: 80060 + firstName: Anna + lastName: Smith + description: Success response. + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply: + post: + description: | + Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take + some time to be visible. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyAction + x-operationVerb: apply + x-auditCategory: ontologyDataTransform + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - api:ontologies-write + - BearerAuth: [] + parameters: + - description: | + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. + in: path + name: ontologyRid + required: true + schema: + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: | + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. + in: path + name: actionType + required: true + schema: + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyActionRequest" + example: + parameters: + id: 80060 + newName: Anna Smith-Doe + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyActionResponse" + example: {} + description: Success response. + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch: + post: + description: | + Applies multiple actions (of the same Action Type) using the given parameters. + Changes to the Ontology are eventually consistent and may take some time to be visible. + + Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not + call Functions may receive a higher limit. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and + [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyActionBatch + x-operationVerb: applyBatch + x-auditCategory: ontologyDataTransform + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - api:ontologies-write + - BearerAuth: [] + parameters: - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. + in: path + name: ontologyRid + required: true schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - 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" - in: query - name: excludeRid + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. + in: path + name: actionType + required: true schema: - type: boolean - x-safety: safe + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/BatchApplyActionRequest" + example: + requests: + - parameters: + id: 80060 + newName: Anna Smith-Doe + - parameters: + id: 80061 + newName: Joe Bloggs responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyObjectV2" - example: - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - __primaryKey: 50030 - __apiName: Employee - id: 50030 - firstName: John - lastName: Doe + $ref: "#/components/schemas/BatchApplyActionResponse" + example: {} description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}: - get: + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync: + post: description: | - Get the metadata of attachments parented to the given object. + Applies an action asynchronously using the given parameters. Changes to the Ontology are eventually consistent + and may take some time to be visible. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently + supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: listPropertyAttachments - x-operationVerb: getAttachment - x-auditCategory: metaDataAccess - x-releaseStage: STABLE + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyActionAsync + x-operationVerb: applyAsync + x-auditCategory: ontologyDataTransform + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: objectType + name: actionType required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee - description: | - The primary key of the object containing the attachment. + Represents a boolean value that restricts an endpoint to preview mode when set to true. + in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AsyncApplyActionRequest" + example: + parameters: + id: 80060 + newName: Anna Smith-Doe + responses: + "202": + content: + application/json: + schema: + $ref: "#/components/schemas/AsyncActionOperation" + example: + data: + - id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + operationType: applyActionAsync + status: RUNNING + stage: RUNNING_SUBMISSION_CHECKS + description: Success response. + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}: + get: + operationId: getAsyncActionStatus + x-operationVerb: getOperationStatus + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA + security: + - BearerAuth: + - api:ontologies-read + - api:ontologies-write + parameters: + - description: | + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: primaryKey + name: ontologyRid required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: property + name: actionType required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + - in: path + name: actionRid + required: true schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/ActionRid" - description: | - The package name of the generated SDK. + Represents a boolean value that restricts an endpoint to preview mode when set to true. in: query - name: packageName + name: preview required: false schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/PreviewMode" + example: true responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AttachmentMetadataResponse" + $ref: "#/components/schemas/AsyncActionOperation" example: - type: single - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}: + id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + operationType: applyActionAsync + status: SUCCESSFUL + result: + type: success + description: Success response + /api/v1/ontologies/{ontologyRid}/queryTypes: get: description: | - Get the metadata of a particular attachment in an attachment list. + Lists the query types for the given Ontology. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentPropertyByRidV2 - x-operationVerb: getAttachmentByRid - x-auditCategory: metaDataAccess + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listQueryTypes + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -8945,83 +8482,72 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object containing the attachment. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: The RID of the attachment. - name: attachmentRid + The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path + name: ontologyRid required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The repository associated with a marketplace installation. + The desired size of the page to be returned. Defaults to 100. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query - name: artifactRepository + name: pageSize required: false schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken required: false schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AttachmentV2" + $ref: "#/components/schemas/ListQueryTypesResponse" example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + 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 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content: + /api/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}: get: description: | - Get the content of an attachment. + Gets a specific query type with the given API name. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentPropertyContentV2 - x-operationVerb: readAttachment - x-auditCategory: dataExport + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getQueryType + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -9029,154 +8555,181 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + The API name of the query type. To find the API name, use the **List query types** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: queryApiName required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/QueryType" + 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 + description: Success response. + /api/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute: + post: + description: | + Executes a Query using the given parameters. Optional parameters do not need to be supplied. + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: executeQuery + x-operationVerb: execute + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: - description: | - The primary key of the object containing the attachment. + The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: primaryKey + name: ontologyRid required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. + The API name of the Query to execute. in: path - name: property + name: queryApiName required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ExecuteQueryRequest" + example: + parameters: + city: New York responses: "200": content: - '*/*': + application/json: schema: - format: binary - type: string + $ref: "#/components/schemas/ExecuteQueryResponse" + example: + value: + - EMP546 + - EMP609 + - EMP989 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content: - get: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/search: + post: description: | - Get the content of an attachment by its RID. + Search for objects in the specified ontology and object type. The request body is used + to filter objects based on the specified query. The supported queries are: - The RID must exist in the attachment array of the property. + | Query type | Description | Supported Types | + |----------|-----------------------------------------------------------------------------------|---------------------------------| + | lt | The provided property is less than the provided value. | number, string, date, timestamp | + | gt | The provided property is greater than the provided value. | number, string, date, timestamp | + | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | + | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | + | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | + | isNull | The provided property is (or is not) null. | all | + | contains | The provided property contains the provided value. | array | + | not | The sub-query does not match. | N/A (applied on a query) | + | and | All the sub-queries match. | N/A (applied on queries) | + | or | At least one of the sub-queries match. | N/A (applied on queries) | + | prefix | The provided property starts with the provided value. | string | + | phrase | The provided property contains the provided value as a substring. | string | + | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | + | allTerms | The provided property contains all the terms separated by whitespace. | string | | - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentPropertyContentByRidV2 - x-operationVerb: readAttachmentByRid - x-auditCategory: dataExport + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: searchObjects + x-operationVerb: search + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: The type of the requested objects. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - - description: | - The primary key of the object containing the attachment. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: The RID of the attachment. - name: attachmentRid - in: path - required: true - schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SearchObjectsRequest" + example: + query: + not: + field: properties.age + eq: 21 responses: "200": content: - '*/*': + application/json: schema: - format: binary - type: string + $ref: "#/components/schemas/SearchObjectsResponse" + example: + data: + - properties: + lastName: smith + firstName: john + age: 21 + rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint: - get: + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/validate: + post: description: | - Get the first point of a time series property. + Validates if an action can be run with the given set of parameters. + The response contains the evaluation of parameters and **submission criteria** + that determine if the request is `VALID` or `INVALID`. + For performance reasons, validations will not consider existing objects or other data in Foundry. + For example, the uniqueness of a primary key or the existence of a user ID will not be checked. + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. Unspecified parameters will be given a default value of `null`. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getFirstPoint - x-operationVerb: getFirstPoint - x-auditCategory: ontologyDataLoad + operationId: validateAction + x-operationVerb: validate + x-auditCategory: ontologyLogicAccess x-releaseStage: STABLE security: - OAuth2: @@ -9184,218 +8737,212 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object with the time series property. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: primaryKey + name: ontologyRid required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the time series property. To find the API name for your time series property, - check the **Ontology Manager** or use the **Get object type** endpoint. + The API name of the action to validate. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: property + name: actionType required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ValidateActionRequest" + 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 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/TimeSeriesPoint" + $ref: "#/components/schemas/ValidateActionResponse" + 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 description: Success response. - "204": - description: No Content - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint: - get: + /api/v1/attachments/upload: + post: description: | - Get the last point of a time series property. + Upload an attachment to use in an action. Any attachment which has not been linked to an object via + an action within one hour after upload will be removed. + Previously mapped attachments which are not connected to any object anymore are also removed on + a biweekly basis. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getLastPoint - x-operationVerb: getLastPoint - x-auditCategory: ontologyDataLoad + following operation scopes: `api:ontologies-write`. + operationId: uploadAttachment + x-operationVerb: upload + x-auditCategory: dataCreate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object with the time series property. - in: path - name: primaryKey + - description: The size in bytes of the file content being uploaded. + in: header + name: Content-Length required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the time series property. To find the API name for your time series property, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property + $ref: "#/components/schemas/ContentLength" + - description: The media type of the file being uploaded. + in: header + name: Content-Type required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. + $ref: "#/components/schemas/ContentType" + - description: The name of the file being uploaded. in: query - name: packageName - required: false + name: filename + required: true schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/Filename" + example: My Image.jpeg + requestBody: + content: + '*/*': + schema: + format: binary + type: string responses: "200": content: application/json: schema: - $ref: "#/components/schemas/TimeSeriesPoint" + $ref: "#/components/schemas/Attachment" + example: + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - "204": - description: No Content - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints: - post: + /api/v1/attachments/{attachmentRid}/content: + get: description: | - Stream all of the points of a time series property. + Get the content of an attachment. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: streamPoints - x-operationVerb: streamPoints - x-auditCategory: ontologyDataLoad + operationId: getAttachmentContent + x-operationVerb: read + x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object with the time series property. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the time series property. To find the API name for your time series property, - check the **Ontology Manager** or use the **Get object type** endpoint. + - description: The RID of the attachment. in: path - name: property + name: attachmentRid required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: null - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/StreamTimeSeriesPointsRequest" - example: - range: - type: relative - startTime: - when: BEFORE - value: 5 - unit: MONTHS - endTime: - when: BEFORE - value: 1 - unit: MONTHS + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f responses: "200": content: @@ -9403,480 +8950,439 @@ paths: schema: format: binary type: string + description: Success response. + /api/v1/attachments/{attachmentRid}: + get: + description: | + Get the metadata of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getAttachment + x-operationVerb: get + x-auditCategory: metaDataAccess + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: The RID of the attachment. + in: path + name: attachmentRid + required: true + schema: + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/Attachment" example: - data: - - time: 2020-03-06T12:00:00Z - value: 48.5 - - time: 2020-03-06T13:00:00Z - value: 75.01 - - time: 2020-03-06T14:00:00Z - value: 31.33 + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - /api/v2/ontologies/{ontology}/actions/{action}/apply: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate: post: - description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" - operationId: applyActionV2 - x-operationVerb: apply - x-auditCategory: ontologyDataTransform + description: | + Perform functions on object fields in the specified ontology and object type. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: aggregateObjects + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: The type of the object to aggregate on. in: path - name: action + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee requestBody: content: application/json: schema: - $ref: "#/components/schemas/ApplyActionRequestV2" + $ref: "#/components/schemas/AggregateObjectsRequest" example: - parameters: - id: 80060 - newName: Anna Smith-Doe + 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 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SyncApplyActionResponseV2" + $ref: "#/components/schemas/AggregateObjectsResponse" example: - validation: - result: VALID - parameters: - id: - evaluatedConstraints: [] - result: VALID - required: true - newName: - evaluatedConstraints: [] - result: VALID - required: true + 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 description: Success response. - /api/v2/ontologies/{ontology}/actions/{action}/applyBatch: - post: + /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes: + get: description: | - Applies multiple actions (of the same Action Type) using the given parameters. - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not - call Functions may receive a higher limit. - - Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyActionBatchV2 - x-operationVerb: applyBatch - x-auditCategory: ontologyDataTransform + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: listOutgoingLinkTypes + x-operationVerb: listOutgoingLinkTypes + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager** application. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. in: path - name: action + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - description: | - The repository associated with a marketplace installation. + $ref: "#/components/schemas/ObjectTypeApiName" + example: Flight + - description: The desired size of the page to be returned. in: query - name: artifactRepository + name: pageSize required: false schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken required: false schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BatchApplyActionRequestV2" - example: - requests: - - parameters: - id: 80060 - newName: Anna Smith-Doe - - parameters: - id: 80061 - newName: Joe Bloggs + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/BatchApplyActionResponseV2" - example: {} + $ref: "#/components/schemas/ListOutgoingLinkTypesResponse" + example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + data: + - apiName: originAirport + objectTypeApiName: Airport + cardinality: ONE + foreignKeyPropertyApiName: originAirportId description: Success response. - /api/v2/ontologies/{ontology}/actions/{action}/applyAsync: - post: - description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" - operationId: applyActionAsyncV2 - x-operationVerb: applyAsync - x-auditCategory: ontologyDataTransform - x-releaseStage: PRIVATE_BETA + /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: + get: + description: | + Get an outgoing link for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getOutgoingLinkType + x-operationVerb: getOutgoingLinkType + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager** application. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. in: path - name: action + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/ObjectTypeApiName" + example: Employee - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false + The API name of the outgoing link. + To find the API name for your link type, check the **Ontology Manager**. + in: path + name: linkType + required: true schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AsyncApplyActionRequestV2" - example: - parameters: - id: 80060 - newName: Anna Smith-Doe + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AsyncApplyActionResponseV2" + $ref: "#/components/schemas/LinkTypeSide" example: - operationId: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + apiName: directReport + objectTypeApiName: Employee + cardinality: MANY description: Success response. - /api/v2/ontologies/{ontology}/objectSets/createTemporary: + /api/v1/datasets: post: - description: "Creates a temporary `ObjectSet` from the given definition. \n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" - operationId: createTemporaryObjectSetV2 - x-operationVerb: createTemporary - x-auditCategory: ontologyLogicCreate - x-releaseStage: PRIVATE_BETA + description: | + Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: createDataset + x-operationVerb: create + x-auditCategory: metaDataCreate + x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read - - api:ontologies-write + - api:datasets-write - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateTemporaryObjectSetRequestV2" + $ref: "#/components/schemas/CreateDatasetRequest" example: - objectSet: - type: base - objectType: Employee + name: My Dataset + parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 responses: "200": - description: Success response. content: application/json: schema: - $ref: "#/components/schemas/CreateTemporaryObjectSetResponseV2" + $ref: "#/components/schemas/Dataset" example: - objectSetRid: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 - /api/v2/ontologies/{ontology}/objectSets/{objectSetRid}: + rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + path: /Empyrean Airlines/My Important Project/My Dataset + description: "" + /api/v1/datasets/{datasetRid}: get: - description: "Gets the definition of the `ObjectSet` with the given RID. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: getObjectSetV2 + description: | + Gets the Dataset with the given DatasetRid. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: getDataset x-operationVerb: get - x-auditCategory: ontologyLogicAccess - x-releaseStage: PRIVATE_BETA + x-auditCategory: metaDataAccess + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-read + - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The RID of the object set. - in: path - name: objectSetRid + - in: path + name: datasetRid required: true schema: - $ref: "#/components/schemas/ObjectSetRid" - example: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da responses: "200": - description: Success response. content: application/json: schema: - $ref: "#/components/schemas/ObjectSet" + $ref: "#/components/schemas/Dataset" example: - data: - objectSet: - type: base - objectType: Employee - /api/v2/ontologies/{ontology}/objectSets/loadObjects: - post: + rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + name: My Dataset + parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 + description: "" + /api/v1/datasets/{datasetRid}/readTable: + get: description: | - Load the ontology objects present in the `ObjectSet` from the provided object set definition. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + Gets the content of a dataset as a table in the specified format. - Note that null value properties will not be returned. + This endpoint currently does not support views (Virtual datasets composed of other datasets). - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: loadObjectSetV2 - x-operationVerb: load - x-auditCategory: ontologyDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: readTable + x-operationVerb: read + x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology + The RID of the Dataset. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + - description: The identifier (name) of the Branch. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: | + The export format. Must be `ARROW` or `CSV`. + in: query + name: format required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/TableExportFormat" + example: CSV - description: | - The repository associated with a marketplace installation. + A subset of the dataset columns to include in the result. Defaults to all columns. in: query - name: artifactRepository + name: columns required: false schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + type: array + items: + type: string + x-safety: unsafe - description: | - The package name of the generated SDK. + A limit on the number of rows to return. Note that row ordering is non-deterministic. in: query - name: packageName + name: rowLimit required: false schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/LoadObjectSetRequestV2" - example: - objectSet: - type: base - objectType: Employee - pageSize: 10000 - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + type: integer + x-safety: unsafe responses: "200": content: - application/json: + '*/*': schema: - $ref: "#/components/schemas/LoadObjectSetResponseV2" - 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 - description: Success response. - /api/v2/ontologies/{ontology}/objectSets/aggregate: + format: binary + type: string + description: The content stream. + /api/v1/datasets/{datasetRid}/branches: post: - description: "Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: aggregateObjectSetV2 - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch + description: | + Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: createBranch + x-operationVerb: create + x-auditCategory: metaDataCreate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to create the Branch. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da requestBody: content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectSetRequestV2" + $ref: "#/components/schemas/CreateBranchRequest" + example: + branchId: my-branch responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectsResponseV2" + $ref: "#/components/schemas/Branch" 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 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes: + branchId: my-branch + description: "" get: description: | - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + Lists the Branches of a Dataset. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjectTypesV2 + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: listBranches x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to list Branches. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - description: | - The desired size of the page to be returned. Defaults to 500. + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -9893,326 +9399,300 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListObjectTypesV2Response" + $ref: "#/components/schemas/ListBranchesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 - fullName: - dataType: - type: string - office: - description: The unique ID of the employee's primary assigned office - dataType: - type: string - startDate: - description: "The date the employee was hired (most recently, if they were re-hired)" - dataType: - type: date - 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 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}: + - branchId: master + transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 + - branchId: test-v2 + transactionRid: ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f + - branchId: my-branch + description: "" + /api/v1/datasets/{datasetRid}/branches/{branchId}: get: description: | - Gets a specific object type with the given API name. + Get a Branch of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: getBranch + x-operationVerb: get + x-auditCategory: metaDataAccess + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-read + - BearerAuth: [] + parameters: + - description: The Resource Identifier (RID) of the Dataset that contains the Branch. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The identifier (name) of the Branch. + in: path + name: branchId + required: true + schema: + $ref: "#/components/schemas/BranchId" + example: master + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/Branch" + example: + branchId: master + transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 + description: "" + delete: + description: | + Deletes the Branch with the given BranchId. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectTypeV2 - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: deleteBranch + x-operationVerb: delete + x-auditCategory: metaDataDelete x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Branch. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The identifier (name) of the Branch. in: path - name: objectType + name: branchId required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/BranchId" + example: my-branch + responses: + "204": + description: Branch deleted. + /api/v1/datasets/{datasetRid}/transactions: + post: + description: | + Creates a Transaction on a Branch of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: createTransaction + x-operationVerb: create + x-auditCategory: metaDataCreate + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-write + - BearerAuth: [] + parameters: + - description: The Resource Identifier (RID) of the Dataset on which to create the Transaction. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: | + The identifier (name) of the Branch on which to create the Transaction. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTransactionRequest" + example: + transactionType: SNAPSHOT responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ObjectTypeV2" + $ref: "#/components/schemas/Transaction" 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 - fullName: - dataType: - type: string - office: - description: The unique ID of the employee's primary assigned office - dataType: - type: string - startDate: - description: "The date the employee was hired (most recently, if they were re-hired)" - dataType: - type: date - rid: ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: OPEN + createdTime: 2022-10-10T12:23:11.152Z + description: "" + /api/v1/datasets/{datasetRid}/transactions/{transactionRid}: get: description: | - Gets the full metadata for a specific object type with the given API name. + Gets a Transaction of a Dataset. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectTypeFullMetadata + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: getTransaction x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + x-auditCategory: metaDataAccess + x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The Resource Identifier (RID) of the Transaction. in: path - name: objectType + name: transactionRid required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" + $ref: "#/components/schemas/TransactionRid" + example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ObjectTypeFullMetadata" - description: Success response. - /api/v2/ontologies/{ontology}/actionTypes: - get: + $ref: "#/components/schemas/Transaction" + example: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: OPEN + createdTime: 2022-10-10T12:20:15.166Z + description: "" + /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/commit: + post: description: | - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. + Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is + updated to point to the Transaction. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listActionTypesV2 - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: commitTransaction + x-operationVerb: commit + x-auditCategory: metaDataUpdate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The desired size of the page to be returned. Defaults to 500. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The Resource Identifier (RID) of the Transaction. + in: path + name: transactionRid + required: true schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/TransactionRid" + example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListActionTypesResponseV2" + $ref: "#/components/schemas/Transaction" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - 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 - description: Success response. - /api/v2/ontologies/{ontology}/actionTypes/{actionType}: - get: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: COMMITTED + createdTime: 2022-10-10T12:20:15.166Z + closedTime: 2022-10-10T12:23:11.152Z + description: "" + /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort: + post: description: | - Gets a specific action type with the given API name. + Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is + not updated. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getActionTypeV2 - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: abortTransaction + x-operationVerb: abort + x-auditCategory: metaDataUpdate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The name of the action type in the API. + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The Resource Identifier (RID) of the Transaction. in: path - name: actionType + name: transactionRid required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: promote-employee + $ref: "#/components/schemas/TransactionRid" + example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ActionTypeV2" + $ref: "#/components/schemas/Transaction" 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 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: ABORTED + createdTime: 2022-10-10T12:20:15.166Z + closedTime: 2022-10-10T12:23:11.152Z + description: "" + /api/v1/datasets/{datasetRid}/files: get: - description: | - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: listOutgoingLinkTypesV2 - x-operationVerb: listOutgoingLinkTypes - x-auditCategory: ontologyMetaDataLoad + description: "Lists Files contained in a Dataset. By default files are listed on the latest view of the default \nbranch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most\nrecent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the \nbranch if there are no snapshot transactions.\n\nTo **list files on the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will include the most recent version of all files since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **list files on the resolved view of a range of transactions** specify the the start transaction's resource\nidentifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This\nwill include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.\nNote that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when \nthe start and end transactions do not belong to the same root-to-leaf path.\n\nTo **list files on a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that\nTransaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" + operationId: listFiles + x-operationVerb: list + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to list Files. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. - in: path - name: objectType - required: true + $ref: "#/components/schemas/DatasetRid" + - description: The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: Flight - - description: The desired size of the page to be returned. + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: | + The desired size of the page to be returned. Defaults to 1,000. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize required: false @@ -10228,149 +9708,223 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListOutgoingLinkTypesResponseV2" + $ref: "#/components/schemas/ListFilesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: originAirport - objectTypeApiName: Airport - cardinality: ONE - foreignKeyPropertyApiName: originAirportId - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: - get: - description: | - Get an outgoing link for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getOutgoingLinkTypeV2 - x-operationVerb: getOutgoingLinkType - x-auditCategory: ontologyMetaDataLoad + - path: q3-data/my-file.csv + transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d + sizeBytes: 74930 + updatedTime: 2022-10-10T16:44:55.192Z + - path: q2-data/my-file.csv + transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 + sizeBytes: 47819 + updatedTime: 2022-07-12T10:12:50.919Z + - path: q2-data/my-other-file.csv + transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 + sizeBytes: 55320 + updatedTime: 2022-07-12T10:12:46.112Z + description: "" + /api/v1/datasets/{datasetRid}/files:upload: + post: + description: "Uploads a File to an existing Dataset.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n\nBy default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.\nIf the file already exists only the most recent version will be visible in the updated view.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will \nbe created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this\ndefault specify `transactionType` in addition to `branchId`. \nSee [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.\n\nTo **upload a file on a manually opened transaction** specify the Transaction's resource identifier as\n`transactionRid`. This is useful for uploading multiple files in a single transaction. \nSee [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" + operationId: uploadFile + x-operationVerb: upload + x-auditCategory: dataCreate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to upload the File. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. - in: path - name: objectType + $ref: "#/components/schemas/DatasetRid" + - description: The File's path within the Dataset. + in: query + name: filePath required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: Employee - - description: | - The API name of the outgoing link. - To find the API name for your link type, check the **Ontology Manager**. - in: path - name: linkType - required: true + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch on which to upload the File. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/BranchId" + - description: The type of the Transaction to create when using branchId. Defaults to `UPDATE`. + in: query + name: transactionType + required: false + schema: + $ref: "#/components/schemas/TransactionType" + - description: The Resource Identifier (RID) of the open Transaction on which to upload the File. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + requestBody: + content: + '*/*': + schema: + format: binary + type: string responses: "200": content: application/json: schema: - $ref: "#/components/schemas/LinkTypeSideV2" + $ref: "#/components/schemas/File" example: - apiName: directReport - objectTypeApiName: Employee - cardinality: MANY - description: Success response. - /api/v2/ontologies/attachments/upload: - post: - description: | - Upload an attachment to use in an action. Any attachment which has not been linked to an object via - an action within one hour after upload will be removed. - Previously mapped attachments which are not connected to any object anymore are also removed on - a biweekly basis. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-write`. - operationId: uploadAttachmentV2 - x-operationVerb: upload - x-auditCategory: dataCreate + path: q3-data/my-file.csv + transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d + sizeBytes: 74930 + updatedTime: 2022-10-10T16:44:55.192Z + description: "" + /api/v1/datasets/{datasetRid}/files/{filePath}: + get: + description: "Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest\nancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" + operationId: getFileMetadata + x-operationVerb: get + x-auditCategory: metaDataAccess + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-read + - BearerAuth: [] + parameters: + - description: The Resource Identifier (RID) of the Dataset that contains the File. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The File's path within the Dataset. + in: path + name: filePath + required: true + schema: + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/File" + example: + path: q3-data/my-file.csv + transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d + sizeBytes: 74930 + updatedTime: 2022-10-10T16:44:55.192Z + description: "" + delete: + description: "Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default \nbranch - `master` for most enrollments. The file will still be visible on historical views.\n\n#### Advanced Usage\n \nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction \nwill be created and committed on this branch.\n\nTo **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier \nas `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a\nsingle transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to \nopen a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" + operationId: deleteFile + x-operationVerb: delete + x-auditCategory: dataDelete x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-write + - api:datasets-write - BearerAuth: [] parameters: - - description: The size in bytes of the file content being uploaded. - in: header - name: Content-Length + - description: The Resource Identifier (RID) of the Dataset on which to delete the File. + in: path + name: datasetRid required: true schema: - $ref: "#/components/schemas/ContentLength" - - description: The media type of the file being uploaded. - in: header - name: Content-Type + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The File path within the Dataset. + in: path + name: filePath required: true schema: - $ref: "#/components/schemas/ContentType" - - description: The name of the file being uploaded. + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch on which to delete the File. Defaults to `master` for most enrollments. in: query - name: filename - required: true + name: branchId + required: false schema: - $ref: "#/components/schemas/Filename" - example: My Image.jpeg - requestBody: - content: - '*/*': - schema: - format: binary - type: string + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the open delete Transaction on which to delete the File. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AttachmentV2" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg - description: Success response. - /api/v2/ontologies/attachments/{attachmentRid}/content: + "204": + description: File deleted. + /api/v1/datasets/{datasetRid}/files/{filePath}/content: get: - description: | - Get the content of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentContentV2 + description: "Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve the content for the most recent version of the file since the latest snapshot transaction, or the\nearliest ancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest\nsnapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior\nis undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" + operationId: getFileContent x-operationVerb: read x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: The Resource Identifier (RID) of the Dataset that contains the File. in: path - name: attachmentRid + name: datasetRid required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/DatasetRid" + - description: The File's path within the Dataset. + in: path + name: filePath + required: true + schema: + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" responses: "200": content: @@ -10378,80 +9932,151 @@ paths: schema: format: binary type: string - description: Success response. - /api/v2/ontologies/attachments/{attachmentRid}: + description: "" + /api/v1/datasets/{datasetRid}/schema: + put: + description: | + Puts a Schema on an existing Dataset and Branch. + operationId: putSchema + x-operationVerb: replaceSchema + x-auditCategory: metaDataUpdate + x-releaseStage: PRIVATE_BETA + security: + - OAuth2: + - api:datasets-write + - BearerAuth: [] + parameters: + - description: | + The RID of the Dataset on which to put the Schema. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + - description: | + The ID of the Branch on which to put the Schema. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true + requestBody: + content: + application/json: + schema: + type: object + x-type: + type: external + java: com.palantir.foundry.schemas.api.types.FoundrySchema + responses: + "204": + description: "" get: description: | - Get the metadata of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentV2 - x-operationVerb: get + Retrieves the Schema for a Dataset and Branch, if it exists. + operationId: getSchema + x-operationVerb: getSchema x-auditCategory: metaDataAccess - x-releaseStage: STABLE + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: | + The RID of the Dataset. in: path - name: attachmentRid + name: datasetRid required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/DatasetRid" + - description: | + The ID of the Branch. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: | + The TransactionRid that contains the Schema. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AttachmentV2" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg - description: Success response. - /v2/operations/{operationId}: - get: + type: object + x-type: + type: external + java: com.palantir.foundry.schemas.api.types.FoundrySchema + description: "" + "204": + description: no schema + delete: description: | - Get an asynchronous operation by its ID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getOperation - x-operationVerb: get + Deletes the Schema from a Dataset and Branch. + operationId: deleteSchema + x-operationVerb: deleteSchema + x-auditCategory: metaDataDelete x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: "The unique Resource Identifier (RID) of the operation. \nThis is the id returned in the response of the invoking operation.\n" + - description: | + The RID of the Dataset on which to delete the schema. in: path - name: operationId + name: datasetRid required: true schema: - type: string - format: rid - x-safety: safe - example: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/DatasetRid" + - description: | + The ID of the Branch on which to delete the schema. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: | + The RID of the Transaction on which to delete the schema. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true responses: - "200": - content: - application/json: - schema: - x-type: - type: asyncOperationCollection - description: Success response. - /api/v1/ontologies: + "204": + description: Schema deleted. + /api/v2/ontologies: get: description: | Lists the Ontologies visible to the current user. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listOntologies + operationId: listOntologiesV2 x-operationVerb: list x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -10464,7 +10089,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListOntologiesResponse" + $ref: "#/components/schemas/ListOntologiesV2Response" example: data: - apiName: default-ontology @@ -10476,13 +10101,13 @@ paths: description: The ontology shared with our suppliers rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v1/ontologies/{ontologyRid}: + /api/v2/ontologies/{ontology}: get: description: | Gets a specific ontology with the given Ontology RID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getOntology + operationId: getOntologyV2 x-operationVerb: get x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -10492,39 +10117,76 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Ontology" + $ref: "#/components/schemas/OntologyV2" example: apiName: default-ontology displayName: Ontology description: The default ontology rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes: + /api/v2/ontologies/{ontology}/fullMetadata: get: description: | - Lists the object types for the given Ontology. + Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. + operationId: getOntologyFullMetadata + x-operationVerb: getFullMetadata + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/OntologyFullMetadata" + description: Success response. + /api/v2/ontologies/{ontology}/objects/{objectType}: + get: + description: | + Lists the objects for the given Ontology and object type. - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjectTypes + operationId: listObjectsV2 x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -10532,16 +10194,25 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 500. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -10553,70 +10224,171 @@ paths: required: false schema: $ref: "#/components/schemas/PageToken" + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - in: query + name: orderBy + required: false + schema: + $ref: "#/components/schemas/OrderBy" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - 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" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListObjectTypesResponse" + $ref: "#/components/schemas/ListObjectsResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 + - __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 + description: Success response. + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}: + get: + description: | + Gets a specific object with the given primary key. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectV2 + x-operationVerb: get + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the requested object. To look up the expected primary key for your object type, use the + `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - 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" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/OntologyObjectV2" + example: + __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + __primaryKey: 50030 + __apiName: Employee + id: 50030 + firstName: John + lastName: Doe description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}: - get: + /api/v2/ontologies/{ontology}/objects/{objectType}/count: + post: description: | - Gets a specific object type with the given API name. + Returns a count of the objects of the given object type. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectType - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: STABLE + operationId: countObjects + x-operationVerb: count + x-auditCategory: ontologyDataSearch + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. @@ -10626,42 +10398,35 @@ paths: schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ObjectType" + $ref: "#/components/schemas/CountObjectsResponseV2" 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 + count: 100 description: Success response. - /api/v1/ontologies/{ontologyRid}/actionTypes: - get: - description: | - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listActionTypes - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + /api/v2/ontologies/{ontology}/objects/{objectType}/search: + post: + 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| startsWith | The provided property starts with the provided value. | 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 value 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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: searchObjectsV2 + x-operationVerb: search + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: @@ -10669,68 +10434,72 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 500. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The repository associated with a marketplace installation. in: query - name: pageSize + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SearchObjectsRequestV2" + example: + where: + type: eq + field: age + value: 21 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListActionTypesResponse" + $ref: "#/components/schemas/SearchObjectsResponseV2" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 + - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb + __primaryKey: 1000 + __apiName: Employee + employeeId: 1000 + lastName: smith + firstName: john + age: 21 description: Success response. - /api/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}: - get: + /api/v2/ontologies/{ontology}/objects/{objectType}/aggregate: + post: description: | - Gets a specific action type with the given API name. + Perform functions on object fields in the specified ontology and object type. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getActionType - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + operationId: aggregateObjectsV2 + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: @@ -10738,90 +10507,112 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action type. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The name of the action type in the API. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: The type of the object to aggregate on. in: path - name: actionTypeApiName + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: promote-employee + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AggregateObjectsRequestV2" + example: + aggregation: + - type: min + field: properties.tenure + name: min_tenure + - type: avg + field: properties.tenure + name: avg_tenure + query: + not: + field: name + eq: john + groupBy: + - field: startDate + type: range + ranges: + - startValue: 2020-01-01 + endValue: 2020-06-01 + - field: city + type: exact responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ActionType" + $ref: "#/components/schemas/AggregateObjectsResponseV2" 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 + - 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 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}: + /api/v2/ontologies/{ontology}/interfaceTypes: get: - description: | - Lists the objects for the given Ontology and object type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjects + description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nLists 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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: listInterfaceTypes x-operationVerb: list - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: ontology required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 1,000. + The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -10834,569 +10625,519 @@ paths: schema: $ref: "#/components/schemas/PageToken" - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy + name: preview required: false schema: - $ref: "#/components/schemas/OrderBy" + $ref: "#/components/schemas/PreviewMode" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListObjectsResponse" + $ref: "#/components/schemas/ListInterfaceTypesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 + - apiName: Athlete + displayName: Athlete + description: Good at sportsball properties: - id: 20090 - firstName: John - lastName: Haymore + 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 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}: + /api/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}: get: description: | - Gets a specific object with the given primary key. + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Gets a specific object type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObject + operationId: getInterfaceType x-operationVerb: get - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: ontology required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The primary key of the requested object. To look up the expected primary key for your object type, use the - `Get object type` endpoint or the **Ontology Manager**. + The API name of the interface type. To find the API name, use the **List interface types** endpoint or + check the **Ontology Manager**. in: path - name: primaryKey + name: interfaceType required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/InterfaceTypeApiName" + example: Employee - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties + name: preview + required: false schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" + $ref: "#/components/schemas/PreviewMode" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyObject" + $ref: "#/components/schemas/InterfaceType" example: - rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + apiName: Athlete + displayName: Athlete + description: Good at sportsball properties: - id: 50030 - firstName: John - lastName: Doe + 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 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}: - get: - description: | - Lists the linked objects for a specific object and the given link type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listLinkedObjects - x-operationVerb: listLinkedObjects - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/search: + post: + description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\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 value. | 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 value 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\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" + operationId: searchObjectsForInterface + x-operationVerb: search + x-auditCategory: ontologyDataSearch + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object from which the links originate. To look up the expected primary key for your - object type, use the `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey + name: ontology required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the link that exists between the object and the requested objects. - To find the API name for your link type, check the **Ontology Manager**. + The API name of the interface type. To find the API name, use the **List interface types** endpoint or + check the **Ontology Manager**. in: path - name: linkType + name: interfaceType required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport - - description: | - The desired size of the page to be returned. Defaults to 1,000. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false - schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/InterfaceTypeApiName" + example: Employee - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: properties - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy + A boolean flag that, when set to true, enables the use of beta features in preview mode. + in: query + name: preview required: false schema: - $ref: "#/components/schemas/OrderBy" + $ref: "#/components/schemas/PreviewMode" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SearchObjectsForInterfaceRequest" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListLinkedObjectsResponse" + $ref: "#/components/schemas/SearchObjectsResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 + - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb + __primaryKey: 1000 + __apiName: Employee + employeeId: 1000 + lastName: smith + firstName: john + age: 21 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: - get: - description: | - Get a specific linked object that originates from another object. If there is no link between the two objects, - LinkedObjectNotFound is thrown. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getLinkedObject - x-operationVerb: getLinkedObject - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate: + post: + description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: aggregateObjectsForInterface + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - 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**." - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object from which the link originates. To look up the expected primary key for your - object type, use the `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the link that exists between the object and the requested objects. - To find the API name for your link type, check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: linkType + name: ontology required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The primary key of the requested linked object. To look up the expected primary key for your object type, - use the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**. + The API name of the interface type. To find the API name, use the **List interface types** endpoint or + check the **Ontology Manager**. in: path - name: linkedObjectPrimaryKey + name: interfaceType required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 80060 + $ref: "#/components/schemas/InterfaceTypeApiName" + example: Employee - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties + name: preview + required: false schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" + $ref: "#/components/schemas/PreviewMode" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AggregateObjectsRequestV2" + example: + aggregation: + - type: min + field: properties.tenure + name: min_tenure + - type: avg + field: properties.tenure + name: avg_tenure + query: + not: + field: name + eq: john + groupBy: + - field: startDate + type: range + ranges: + - startValue: 2020-01-01 + endValue: 2020-06-01 + - field: city + type: exact responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyObject" + $ref: "#/components/schemas/AggregateObjectsResponseV2" example: - rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 - properties: - id: 80060 - firstName: Anna - lastName: Smith + 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 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply: - post: - description: | - Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take - some time to be visible. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyAction - x-operationVerb: apply - x-auditCategory: ontologyDataTransform + /api/v2/ontologies/{ontology}/queryTypes: + get: + 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\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: listQueryTypesV2 + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. - in: path - name: actionType - required: true + The desired size of the page to be returned. Defaults to 100. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ApplyActionRequest" - example: - parameters: - id: 80060 - newName: Anna Smith-Doe + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ApplyActionResponse" - example: {} + $ref: "#/components/schemas/ListQueryTypesResponseV2" + example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + 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 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch: - post: + /api/v2/ontologies/{ontology}/queryTypes/{queryApiName}: + get: description: | - Applies multiple actions (of the same Action Type) using the given parameters. - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not - call Functions may receive a higher limit. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and - [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Gets a specific query type with the given API name. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyActionBatch - x-operationVerb: applyBatch - x-auditCategory: ontologyDataTransform + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getQueryTypeV2 + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the query type. To find the API name, use the **List query types** endpoint or + check the **Ontology Manager**. in: path - name: actionType + name: queryApiName required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BatchApplyActionRequest" - example: - requests: - - parameters: - id: 80060 - newName: Anna Smith-Doe - - parameters: - id: 80061 - newName: Joe Bloggs + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity responses: "200": content: application/json: schema: - $ref: "#/components/schemas/BatchApplyActionResponse" - example: {} + $ref: "#/components/schemas/QueryTypeV2" + 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 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync: + /api/v2/ontologies/{ontology}/queries/{queryApiName}/execute: post: - description: | - Applies an action asynchronously using the given parameters. Changes to the Ontology are eventually consistent - and may take some time to be visible. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently - supported by this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyActionAsync - x-operationVerb: applyAsync - x-auditCategory: ontologyDataTransform - x-releaseStage: PRIVATE_BETA + description: "Executes a Query using the given parameters.\n\nOptional parameters do not need to be supplied.\n\nThird-party applications using this endpoint via OAuth2 must request the \nfollowing operation scopes: `api:ontologies-read`.\n" + operationId: executeQueryV2 + x-operationVerb: execute + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the Query to execute. in: path - name: actionType + name: queryApiName required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity - description: | - Represents a boolean value that restricts an endpoint to preview mode when set to true. + The repository associated with a marketplace installation. in: query - name: preview + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PreviewMode" - example: true + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" requestBody: content: application/json: schema: - $ref: "#/components/schemas/AsyncApplyActionRequest" + $ref: "#/components/schemas/ExecuteQueryRequest" example: parameters: - id: 80060 - newName: Anna Smith-Doe + city: New York responses: - "202": + "200": content: application/json: schema: - $ref: "#/components/schemas/AsyncActionOperation" + $ref: "#/components/schemas/ExecuteQueryResponse" example: - data: - - id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - operationType: applyActionAsync - status: RUNNING - stage: RUNNING_SUBMISSION_CHECKS + value: + - EMP546 + - EMP609 + - EMP989 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}: get: - operationId: getAsyncActionStatus - x-operationVerb: getOperationStatus - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + description: | + Lists the linked objects for a specific object and the given link type. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listLinkedObjectsV2 + x-operationVerb: listLinkedObjects + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - - BearerAuth: + - OAuth2: - api:ontologies-read - - api:ontologies-write + - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: actionType - required: true - schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - in: path - name: actionRid + name: objectType required: true schema: - $ref: "#/components/schemas/ActionRid" + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - Represents a boolean value that restricts an endpoint to preview mode when set to true. - in: query - name: preview - required: false + The primary key of the object from which the links originate. To look up the expected primary key for your + object type, use the `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true schema: - $ref: "#/components/schemas/PreviewMode" - example: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AsyncActionOperation" - example: - id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - operationType: applyActionAsync - status: SUCCESSFUL - result: - type: success - description: Success response - /api/v1/ontologies/{ontologyRid}/queryTypes: - get: - description: | - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listQueryTypes - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the link that exists between the object and the requested objects. + To find the API name for your link type, check the **Ontology Manager**. in: path - name: ontologyRid + name: linkType required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport - description: | - The desired size of the page to be returned. Defaults to 100. + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -11408,57 +11149,73 @@ paths: required: false schema: $ref: "#/components/schemas/PageToken" + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" - in: query - name: preview + name: orderBy required: false schema: - $ref: "#/components/schemas/PreviewMode" - example: true + $ref: "#/components/schemas/OrderBy" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - 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" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListQueryTypesResponse" + $ref: "#/components/schemas/ListLinkedObjectsResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv 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 + - __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 description: Success response. - /api/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: get: description: | - Gets a specific query type with the given API name. + Get a specific linked object that originates from another object. + + If there is no link between the two objects, `LinkedObjectNotFound` is thrown. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getQueryType - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + operationId: getLinkedObjectV2 + x-operationVerb: getLinkedObject + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -11466,193 +11223,103 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the query type. To find the API name, use the **List query types** endpoint or + The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. in: path - name: queryApiName + name: objectType required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity - - in: query - name: preview - required: false + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object from which the links originate. To look up the expected primary key for your + object type, use the `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true schema: - $ref: "#/components/schemas/PreviewMode" - example: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/QueryType" - 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 - description: Success response. - /api/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute: - post: - description: | - Executes a Query using the given parameters. Optional parameters do not need to be supplied. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: executeQuery - x-operationVerb: execute - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the link that exists between the object and the requested objects. + To find the API name for your link type, check the **Ontology Manager**. in: path - name: ontologyRid + name: linkType required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport - description: | - The API name of the Query to execute. + The primary key of the requested linked object. To look up the expected primary key for your object type, + use the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**. in: path - name: queryApiName + name: linkedObjectPrimaryKey required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity - - in: query - name: preview + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 80060 + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PreviewMode" - example: true - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ExecuteQueryRequest" - example: - parameters: - city: New York - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/ExecuteQueryResponse" - example: - value: - - EMP546 - - EMP609 - - EMP989 - description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/search: - post: - description: | - Search for objects in the specified ontology and object type. The request body is used - to filter objects based on the specified query. The supported queries are: - - | Query type | Description | Supported Types | - |----------|-----------------------------------------------------------------------------------|---------------------------------| - | lt | The provided property is less than the provided value. | number, string, date, timestamp | - | gt | The provided property is greater than the provided value. | number, string, date, timestamp | - | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | - | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | - | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | - | isNull | The provided property is (or is not) null. | all | - | contains | The provided property contains the provided value. | array | - | not | The sub-query does not match. | N/A (applied on a query) | - | and | All the sub-queries match. | N/A (applied on queries) | - | or | At least one of the sub-queries match. | N/A (applied on queries) | - | prefix | The provided property starts with the provided value. | string | - | phrase | The provided property contains the provided value as a substring. | string | - | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | - | allTerms | The provided property contains all the terms separated by whitespace. | string | | - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: searchObjects - x-operationVerb: search - x-auditCategory: ontologyDataSearch - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. - in: path - name: ontologyRid - required: true + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: The type of the requested objects. - in: path - name: objectType - required: true + $ref: "#/components/schemas/SdkPackageName" + - 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" + in: query + name: excludeRid schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsRequest" - example: - query: - not: - field: properties.age - eq: 21 + type: boolean + x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SearchObjectsResponse" + $ref: "#/components/schemas/OntologyObjectV2" example: - data: - - properties: - lastName: smith - firstName: john - age: 21 - rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb + __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + __primaryKey: 50030 + __apiName: Employee + id: 50030 + firstName: John + lastName: Doe description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/validate: - post: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}: + get: description: | - Validates if an action can be run with the given set of parameters. - The response contains the evaluation of parameters and **submission criteria** - that determine if the request is `VALID` or `INVALID`. - For performance reasons, validations will not consider existing objects or other data in Foundry. - For example, the uniqueness of a primary key or the existence of a user ID will not be checked. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. Unspecified parameters will be given a default value of `null`. + Get the metadata of attachments parented to the given object. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: validateAction - x-operationVerb: validate - x-auditCategory: ontologyLogicAccess + operationId: listPropertyAttachments + x-operationVerb: getAttachment + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: @@ -11660,198 +11327,160 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to validate. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: actionType + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ValidateActionRequest" - 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 + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ValidateActionResponse" + $ref: "#/components/schemas/AttachmentMetadataResponse" 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 + type: single + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - /api/v1/attachments/upload: - post: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}: + get: description: | - Upload an attachment to use in an action. Any attachment which has not been linked to an object via - an action within one hour after upload will be removed. - Previously mapped attachments which are not connected to any object anymore are also removed on - a biweekly basis. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + Get the metadata of a particular attachment in an attachment list. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-write`. - operationId: uploadAttachment - x-operationVerb: upload - x-auditCategory: dataCreate + following operation scopes: `api:ontologies-read`. + operationId: getAttachmentPropertyByRidV2 + x-operationVerb: getAttachmentByRid + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The size in bytes of the file content being uploaded. - in: header - name: Content-Length + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey required: true schema: - $ref: "#/components/schemas/ContentLength" - - description: The media type of the file being uploaded. - in: header - name: Content-Type + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property required: true schema: - $ref: "#/components/schemas/ContentType" - - description: The name of the file being uploaded. - in: query - name: filename + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: The RID of the attachment. + name: attachmentRid + in: path required: true schema: - $ref: "#/components/schemas/Filename" - example: My Image.jpeg - requestBody: - content: - '*/*': - schema: - format: binary - type: string + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Attachment" + $ref: "#/components/schemas/AttachmentV2" example: rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f filename: My Image.jpeg sizeBytes: 393469 mediaType: image/jpeg description: Success response. - /api/v1/attachments/{attachmentRid}/content: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content: get: description: | Get the content of an attachment. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getAttachmentContent - x-operationVerb: read + operationId: getAttachmentPropertyContentV2 + x-operationVerb: readAttachment x-auditCategory: dataExport x-releaseStage: STABLE security: @@ -11859,13 +11488,55 @@ paths: - api:ontologies-read - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: attachmentRid + name: ontology required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: @@ -11874,134 +11545,98 @@ paths: format: binary type: string description: Success response. - /api/v1/attachments/{attachmentRid}: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content: get: description: | - Get the metadata of an attachment. + Get the content of an attachment by its RID. + + The RID must exist in the attachment array of the property. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getAttachment - x-operationVerb: get - x-auditCategory: metaDataAccess - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: The RID of the attachment. - in: path - name: attachmentRid - required: true - schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Attachment" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg - description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate: - post: - description: | - Perform functions on object fields in the specified ontology and object type. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: aggregateObjects - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch + operationId: getAttachmentPropertyContentByRidV2 + x-operationVerb: readAttachmentByRid + x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: The type of the object to aggregate on. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsRequest" - 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 - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsResponse" - 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 + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: The RID of the attachment. + name: attachmentRid + in: path + required: true + schema: + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + responses: + "200": + content: + '*/*': + schema: + format: binary + type: string description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint: get: description: | - List the outgoing links for an object type. + Get the first point of a time series property. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: listOutgoingLinkTypes - x-operationVerb: listOutgoingLinkTypes - x-auditCategory: ontologyMetaDataLoad + operationId: getFirstPoint + x-operationVerb: getFirstPoint + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -12009,58 +11644,73 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager** application. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. + check the **Ontology Manager**. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" - example: Flight - - description: The desired size of the page to be returned. + example: employee + - description: | + The primary key of the object with the time series property. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the time series property. To find the API name for your time series property, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. in: query - name: pageSize + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListOutgoingLinkTypesResponse" - example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - data: - - apiName: originAirport - objectTypeApiName: Airport - cardinality: ONE - foreignKeyPropertyApiName: originAirportId + $ref: "#/components/schemas/TimeSeriesPoint" description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: + "204": + description: No Content + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint: get: description: | - Get an outgoing link for an object type. + Get the last point of a time series property. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getOutgoingLinkType - x-operationVerb: getOutgoingLinkType - x-auditCategory: ontologyMetaDataLoad + operationId: getLastPoint + x-operationVerb: getLastPoint + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -12068,175 +11718,144 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager** application. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. + check the **Ontology Manager**. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" - example: Employee + example: employee - description: | - The API name of the outgoing link. - To find the API name for your link type, check the **Ontology Manager**. + The primary key of the object with the time series property. in: path - name: linkType + name: primaryKey required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the time series property. To find the API name for your time series property, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/LinkTypeSide" - example: - apiName: directReport - objectTypeApiName: Employee - cardinality: MANY + $ref: "#/components/schemas/TimeSeriesPoint" description: Success response. - /api/v1/datasets: + "204": + description: No Content + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints: post: description: | - Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: createDataset - x-operationVerb: create - x-auditCategory: metaDataCreate - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-write - - BearerAuth: [] - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateDatasetRequest" - example: - name: My Dataset - parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Dataset" - example: - rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - path: /Empyrean Airlines/My Important Project/My Dataset - description: "" - /api/v1/datasets/{datasetRid}: - get: - description: | - Gets the Dataset with the given DatasetRid. + Stream all of the points of a time series property. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: getDataset - x-operationVerb: get - x-auditCategory: metaDataAccess + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: streamPoints + x-operationVerb: streamPoints + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - in: path - name: datasetRid + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Dataset" - example: - rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - name: My Dataset - parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 - description: "" - /api/v1/datasets/{datasetRid}/readTable: - get: - description: | - Gets the content of a dataset as a table in the specified format. - - This endpoint currently does not support views (Virtual datasets composed of other datasets). - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: readTable - x-operationVerb: read - x-auditCategory: dataExport - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-read - - BearerAuth: [] - parameters: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The RID of the Dataset. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: objectType required: true schema: - $ref: "#/components/schemas/DatasetRid" - - description: The identifier (name) of the Branch. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object with the time series property. + in: path + name: primaryKey + required: true schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - The export format. Must be `ARROW` or `CSV`. - in: query - name: format + The API name of the time series property. To find the API name for your time series property, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property required: true schema: - $ref: "#/components/schemas/TableExportFormat" - example: CSV + $ref: "#/components/schemas/PropertyApiName" + example: null - description: | - A subset of the dataset columns to include in the result. Defaults to all columns. + The repository associated with a marketplace installation. in: query - name: columns + name: artifactRepository required: false schema: - type: array - items: - type: string - x-safety: unsafe + $ref: "#/components/schemas/ArtifactRepositoryRid" - description: | - A limit on the number of rows to return. Note that row ordering is non-deterministic. + The package name of the generated SDK. in: query - name: rowLimit + name: packageName required: false schema: - type: integer - x-safety: unsafe + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/StreamTimeSeriesPointsRequest" + example: + range: + type: relative + startTime: + when: BEFORE + value: 5 + unit: MONTHS + endTime: + when: BEFORE + value: 1 + unit: MONTHS responses: "200": content: @@ -12244,377 +11863,480 @@ paths: schema: format: binary type: string - description: The content stream. - /api/v1/datasets/{datasetRid}/branches: + example: + data: + - time: 2020-03-06T12:00:00Z + value: 48.5 + - time: 2020-03-06T13:00:00Z + value: 75.01 + - time: 2020-03-06T14:00:00Z + value: 31.33 + description: Success response. + /api/v2/ontologies/{ontology}/actions/{action}/apply: post: - description: | - Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: createBranch - x-operationVerb: create - x-auditCategory: metaDataCreate + description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" + operationId: applyActionV2 + x-operationVerb: apply + x-auditCategory: ontologyDataTransform x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to create the Branch. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateBranchRequest" - example: - branchId: my-branch - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Branch" - example: - branchId: my-branch - description: "" - get: - description: | - Lists the Branches of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: listBranches - x-operationVerb: list - x-auditCategory: metaDataAccess - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-read - - BearerAuth: [] - parameters: - - description: The Resource Identifier (RID) of the Dataset on which to list Branches. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: datasetRid + name: action required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee - description: | - The desired size of the page to be returned. Defaults to 1,000. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + The repository associated with a marketplace installation. in: query - name: pageSize + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyActionRequestV2" + example: + parameters: + id: 80060 + newName: Anna Smith-Doe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListBranchesResponse" + $ref: "#/components/schemas/SyncApplyActionResponseV2" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - data: - - branchId: master - transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 - - branchId: test-v2 - transactionRid: ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f - - branchId: my-branch - description: "" - /api/v1/datasets/{datasetRid}/branches/{branchId}: - get: + validation: + result: VALID + parameters: + id: + evaluatedConstraints: [] + result: VALID + required: true + newName: + evaluatedConstraints: [] + result: VALID + required: true + description: Success response. + /api/v2/ontologies/{ontology}/actions/{action}/applyBatch: + post: description: | - Get a Branch of a Dataset. + Applies multiple actions (of the same Action Type) using the given parameters. + Changes to the Ontology are eventually consistent and may take some time to be visible. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: getBranch - x-operationVerb: get - x-auditCategory: metaDataAccess + Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not + call Functions may receive a higher limit. + + Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyActionBatchV2 + x-operationVerb: applyBatch + x-auditCategory: ontologyDataTransform x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Branch. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The identifier (name) of the Branch. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: branchId + name: action required: true schema: - $ref: "#/components/schemas/BranchId" - example: master + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/BatchApplyActionRequestV2" + example: + requests: + - parameters: + id: 80060 + newName: Anna Smith-Doe + - parameters: + id: 80061 + newName: Joe Bloggs responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Branch" - example: - branchId: master - transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 - description: "" - delete: - description: | - Deletes the Branch with the given BranchId. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: deleteBranch - x-operationVerb: delete - x-auditCategory: metaDataDelete - x-releaseStage: STABLE + $ref: "#/components/schemas/BatchApplyActionResponseV2" + example: {} + description: Success response. + /api/v2/ontologies/{ontology}/actions/{action}/applyAsync: + post: + description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" + operationId: applyActionAsyncV2 + x-operationVerb: applyAsync + x-auditCategory: ontologyDataTransform + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-write + - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Branch. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The identifier (name) of the Branch. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: branchId + name: action required: true schema: - $ref: "#/components/schemas/BranchId" - example: my-branch + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AsyncApplyActionRequestV2" + example: + parameters: + id: 80060 + newName: Anna Smith-Doe responses: - "204": - description: Branch deleted. - /api/v1/datasets/{datasetRid}/transactions: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/AsyncApplyActionResponseV2" + example: + operationId: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + description: Success response. + /api/v2/ontologies/{ontology}/objectSets/createTemporary: post: - description: | - Creates a Transaction on a Branch of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: createTransaction - x-operationVerb: create - x-auditCategory: metaDataCreate - x-releaseStage: STABLE + description: "Creates a temporary `ObjectSet` from the given definition. \n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" + operationId: createTemporaryObjectSetV2 + x-operationVerb: createTemporary + x-auditCategory: ontologyLogicCreate + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-write + - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to create the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: | - The identifier (name) of the Branch on which to create the Transaction. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateTransactionRequest" + $ref: "#/components/schemas/CreateTemporaryObjectSetRequestV2" example: - transactionType: SNAPSHOT + objectSet: + type: base + objectType: Employee responses: "200": + description: Success response. content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/CreateTemporaryObjectSetResponseV2" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: OPEN - createdTime: 2022-10-10T12:23:11.152Z - description: "" - /api/v1/datasets/{datasetRid}/transactions/{transactionRid}: + objectSetRid: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 + /api/v2/ontologies/{ontology}/objectSets/{objectSetRid}: get: - description: | - Gets a Transaction of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: getTransaction + description: "Gets the definition of the `ObjectSet` with the given RID. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: getObjectSetV2 x-operationVerb: get - x-auditCategory: metaDataAccess - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-read - - BearerAuth: [] + x-auditCategory: ontologyLogicAccess + x-releaseStage: PRIVATE_BETA parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The Resource Identifier (RID) of the Transaction. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The RID of the object set. in: path - name: transactionRid + name: objectSetRid required: true schema: - $ref: "#/components/schemas/TransactionRid" - example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + $ref: "#/components/schemas/ObjectSetRid" + example: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 responses: "200": + description: Success response. content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/ObjectSet" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: OPEN - createdTime: 2022-10-10T12:20:15.166Z - description: "" - /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/commit: + data: + objectSet: + type: base + objectType: Employee + /api/v2/ontologies/{ontology}/objectSets/loadObjects: post: description: | - Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is - updated to point to the Transaction. + Load the ontology objects present in the `ObjectSet` from the provided object set definition. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: commitTransaction - x-operationVerb: commit - x-auditCategory: metaDataUpdate + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: loadObjectSetV2 + x-operationVerb: load + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The Resource Identifier (RID) of the Transaction. - in: path - name: transactionRid - required: true + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false schema: - $ref: "#/components/schemas/TransactionRid" - example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/LoadObjectSetRequestV2" + example: + objectSet: + type: base + objectType: Employee + pageSize: 10000 + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/LoadObjectSetResponseV2" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: COMMITTED - createdTime: 2022-10-10T12:20:15.166Z - closedTime: 2022-10-10T12:23:11.152Z - description: "" - /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort: + 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 + description: Success response. + /api/v2/ontologies/{ontology}/objectSets/aggregate: post: - description: | - Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is - not updated. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: abortTransaction - x-operationVerb: abort - x-auditCategory: metaDataUpdate + description: "Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: aggregateObjectSetV2 + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The Resource Identifier (RID) of the Transaction. - in: path - name: transactionRid - required: true + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false schema: - $ref: "#/components/schemas/TransactionRid" - example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AggregateObjectSetRequestV2" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/AggregateObjectsResponseV2" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: ABORTED - createdTime: 2022-10-10T12:20:15.166Z - closedTime: 2022-10-10T12:23:11.152Z - description: "" - /api/v1/datasets/{datasetRid}/files: + 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 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes: get: - description: "Lists Files contained in a Dataset. By default files are listed on the latest view of the default \nbranch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most\nrecent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the \nbranch if there are no snapshot transactions.\n\nTo **list files on the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will include the most recent version of all files since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **list files on the resolved view of a range of transactions** specify the the start transaction's resource\nidentifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This\nwill include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.\nNote that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when \nthe start and end transactions do not belong to the same root-to-leaf path.\n\nTo **list files on a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that\nTransaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" - operationId: listFiles + description: | + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listObjectTypesV2 x-operationVerb: list - x-auditCategory: metaDataAccess + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to list Files. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - - description: The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 1,000. + The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -12631,443 +12353,484 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListFilesResponse" + $ref: "#/components/schemas/ListObjectTypesV2Response" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - path: q3-data/my-file.csv - transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d - sizeBytes: 74930 - updatedTime: 2022-10-10T16:44:55.192Z - - path: q2-data/my-file.csv - transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 - sizeBytes: 47819 - updatedTime: 2022-07-12T10:12:50.919Z - - path: q2-data/my-other-file.csv - transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 - sizeBytes: 55320 - updatedTime: 2022-07-12T10:12:46.112Z - description: "" - /api/v1/datasets/{datasetRid}/files:upload: - post: - description: "Uploads a File to an existing Dataset.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n\nBy default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.\nIf the file already exists only the most recent version will be visible in the updated view.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will \nbe created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this\ndefault specify `transactionType` in addition to `branchId`. \nSee [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.\n\nTo **upload a file on a manually opened transaction** specify the Transaction's resource identifier as\n`transactionRid`. This is useful for uploading multiple files in a single transaction. \nSee [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" - operationId: uploadFile - x-operationVerb: upload - x-auditCategory: dataCreate - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-write - - BearerAuth: [] - parameters: - - description: The Resource Identifier (RID) of the Dataset on which to upload the File. - in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - - description: The File's path within the Dataset. - in: query - name: filePath - required: true - schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch on which to upload the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The type of the Transaction to create when using branchId. Defaults to `UPDATE`. - in: query - name: transactionType - required: false - schema: - $ref: "#/components/schemas/TransactionType" - - description: The Resource Identifier (RID) of the open Transaction on which to upload the File. - in: query - name: transactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - requestBody: - content: - '*/*': - schema: - format: binary - type: string - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/File" - example: - path: q3-data/my-file.csv - transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d - sizeBytes: 74930 - updatedTime: 2022-10-10T16:44:55.192Z - description: "" - /api/v1/datasets/{datasetRid}/files/{filePath}: + - apiName: employee + description: A full-time or part-time employee of our firm + displayName: Employee + status: ACTIVE + primaryKey: employeeId + properties: + employeeId: + dataType: + type: integer + fullName: + dataType: + type: string + office: + description: The unique ID of the employee's primary assigned office + dataType: + type: string + startDate: + description: "The date the employee was hired (most recently, if they were re-hired)" + dataType: + type: date + 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 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}: get: - description: "Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest\nancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" - operationId: getFileMetadata + description: | + Gets a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectTypeV2 x-operationVerb: get - x-auditCategory: metaDataAccess + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the File. - in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The File's path within the Dataset. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: filePath + name: ontology required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee responses: "200": content: application/json: schema: - $ref: "#/components/schemas/File" + $ref: "#/components/schemas/ObjectTypeV2" example: - path: q3-data/my-file.csv - transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d - sizeBytes: 74930 - updatedTime: 2022-10-10T16:44:55.192Z - description: "" - delete: - description: "Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default \nbranch - `master` for most enrollments. The file will still be visible on historical views.\n\n#### Advanced Usage\n \nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction \nwill be created and committed on this branch.\n\nTo **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier \nas `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a\nsingle transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to \nopen a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" - operationId: deleteFile - x-operationVerb: delete - x-auditCategory: dataDelete - x-releaseStage: STABLE + apiName: employee + description: A full-time or part-time employee of our firm + displayName: Employee + status: ACTIVE + primaryKey: employeeId + properties: + employeeId: + dataType: + type: integer + fullName: + dataType: + type: string + office: + description: The unique ID of the employee's primary assigned office + dataType: + type: string + startDate: + description: "The date the employee was hired (most recently, if they were re-hired)" + dataType: + type: date + rid: ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata: + get: + description: | + Gets the full metadata for a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectTypeFullMetadata + x-operationVerb: getFullMetadata + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to delete the File. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The File path within the Dataset. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: filePath + name: objectType required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch on which to delete the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the open delete Transaction on which to delete the File. + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: transactionRid + name: preview required: false schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/PreviewMode" responses: - "204": - description: File deleted. - /api/v1/datasets/{datasetRid}/files/{filePath}/content: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ObjectTypeFullMetadata" + description: Success response. + /api/v2/ontologies/{ontology}/actionTypes: get: - description: "Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve the content for the most recent version of the file since the latest snapshot transaction, or the\nearliest ancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest\nsnapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior\nis undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" - operationId: getFileContent - x-operationVerb: read - x-auditCategory: dataExport + description: | + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listActionTypesV2 + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the File. - in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - - description: The File's path within the Dataset. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: filePath + name: ontology required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The desired size of the page to be returned. Defaults to 500. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query - name: startTransactionRid + name: pageSize required: false schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken required: false schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/PageToken" responses: "200": content: - '*/*': + application/json: schema: - format: binary - type: string - description: "" - /api/v1/datasets/{datasetRid}/schema: - put: + $ref: "#/components/schemas/ListActionTypesResponseV2" + example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + 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 + description: Success response. + /api/v2/ontologies/{ontology}/actionTypes/{actionType}: + get: description: | - Puts a Schema on an existing Dataset and Branch. - operationId: putSchema - x-operationVerb: replaceSchema - x-auditCategory: metaDataUpdate - x-releaseStage: PRIVATE_BETA + Gets a specific action type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getActionTypeV2 + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - description: | - The RID of the Dataset on which to put the Schema. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The ID of the Branch on which to put the Schema. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" - example: true - requestBody: - content: - application/json: - schema: - type: object - x-type: - type: external - java: com.palantir.foundry.schemas.api.types.FoundrySchema + The name of the action type in the API. + in: path + name: actionType + required: true + schema: + $ref: "#/components/schemas/ActionTypeApiName" + example: promote-employee responses: - "204": - description: "" + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ActionTypeV2" + 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 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes: get: description: | - Retrieves the Schema for a Dataset and Branch, if it exists. - operationId: getSchema - x-operationVerb: getSchema - x-auditCategory: metaDataAccess - x-releaseStage: PRIVATE_BETA + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: listOutgoingLinkTypesV2 + x-operationVerb: listOutgoingLinkTypes + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - description: | - The RID of the Dataset. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The ID of the Branch. - in: query - name: branchId - required: false + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. + in: path + name: objectType + required: true schema: - $ref: "#/components/schemas/BranchId" - - description: | - The TransactionRid that contains the Schema. + $ref: "#/components/schemas/ObjectTypeApiName" + example: Flight + - description: The desired size of the page to be returned. in: query - name: transactionRid + name: pageSize required: false schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/PageSize" - in: query - name: preview + name: pageToken required: false schema: - $ref: "#/components/schemas/PreviewMode" - example: true + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - type: object - x-type: - type: external - java: com.palantir.foundry.schemas.api.types.FoundrySchema - description: "" - "204": - description: no schema - delete: + $ref: "#/components/schemas/ListOutgoingLinkTypesResponseV2" + example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + data: + - apiName: originAirport + objectTypeApiName: Airport + cardinality: ONE + foreignKeyPropertyApiName: originAirportId + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: + get: description: | - Deletes the Schema from a Dataset and Branch. - operationId: deleteSchema - x-operationVerb: deleteSchema - x-auditCategory: metaDataDelete - x-releaseStage: PRIVATE_BETA + Get an outgoing link for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getOutgoingLinkTypeV2 + x-operationVerb: getOutgoingLinkType + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - description: | - The RID of the Dataset on which to delete the schema. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The ID of the Branch on which to delete the schema. - in: query - name: branchId - required: false + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. + in: path + name: objectType + required: true schema: - $ref: "#/components/schemas/BranchId" + $ref: "#/components/schemas/ObjectTypeApiName" + example: Employee - description: | - The RID of the Transaction on which to delete the schema. - in: query - name: transactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - in: query - name: preview - required: false + The API name of the outgoing link. + To find the API name for your link type, check the **Ontology Manager**. + in: path + name: linkType + required: true schema: - $ref: "#/components/schemas/PreviewMode" - example: true + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport responses: - "204": - description: Schema deleted. - /api/v1/models/languageModels/{modelName}/chatCompletions: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/LinkTypeSideV2" + example: + apiName: directReport + objectTypeApiName: Employee + cardinality: MANY + description: Success response. + /api/v2/ontologies/attachments/upload: post: description: | - Creates a chat completion for a prompt. - operationId: createChatCompletion - x-releaseStage: PRIVATE_BETA + Upload an attachment to use in an action. Any attachment which has not been linked to an object via + an action within one hour after upload will be removed. + Previously mapped attachments which are not connected to any object anymore are also removed on + a biweekly basis. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-write`. + operationId: uploadAttachmentV2 + x-operationVerb: upload + x-auditCategory: dataCreate + x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read - api:ontologies-write - BearerAuth: [] parameters: - - description: | - The API name of the model to use for the completion. - in: path - name: modelName + - description: The size in bytes of the file content being uploaded. + in: header + name: Content-Length + required: true + schema: + $ref: "#/components/schemas/ContentLength" + - description: The media type of the file being uploaded. + in: header + name: Content-Type + required: true + schema: + $ref: "#/components/schemas/ContentType" + - description: The name of the file being uploaded. + in: query + name: filename required: true schema: - $ref: "#/components/schemas/LanguageModelApiName" - example: gpt_v4 + $ref: "#/components/schemas/Filename" + example: My Image.jpeg requestBody: content: - application/json: + '*/*': schema: - $ref: "#/components/schemas/ChatCompletionRequest" - example: - messages: - - role: USER - content: Hello. - parameters: - temperature: 0.8 + format: binary + type: string responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ChatCompletionResponse" + $ref: "#/components/schemas/AttachmentV2" example: - choices: - - message: - role: ASSISTANT - content: Hello. + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - /api/v1/models/languageModels/{modelName}/chatCompletions/stream: - post: + /api/v2/ontologies/attachments/{attachmentRid}/content: + get: description: | - Runs the same query as create chat completion, but streams the raw response as a string of UTF8 encoded bytes. - Note: This endpoint returns only the string response. - operationId: streamChatCompletion - x-releaseStage: PRIVATE_BETA + Get the content of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getAttachmentContentV2 + x-operationVerb: read + x-auditCategory: dataExport + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - - description: | - The API name of the model to use for the completion. + - description: The RID of the attachment. in: path - name: modelName + name: attachmentRid required: true schema: - $ref: "#/components/schemas/LanguageModelApiName" - example: gpt_v4 - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ChatCompletionRequest" - example: - messages: - - role: USER - content: Hello. - parameters: - temperature: 0.8 + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f responses: "200": content: @@ -13075,36 +12838,39 @@ paths: schema: format: binary type: string - example: Hello. description: Success response. - /api/v1/models/languageModels: + /api/v2/ontologies/attachments/{attachmentRid}: get: description: | - Lists the language models available. Can be filtered by source. - operationId: listLanguageModels - x-operationVerb: list - x-releaseStage: PRIVATE_BETA + Get the metadata of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getAttachmentV2 + x-operationVerb: get + x-auditCategory: metaDataAccess + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - name: source - in: query - description: language model source + - description: The RID of the attachment. + in: path + name: attachmentRid + required: true schema: - $ref: "#/components/schemas/LanguageModelSource" - required: false + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListLanguageModelsResponse" + $ref: "#/components/schemas/AttachmentV2" example: - data: - - apiName: gpt_v4 - source: global - - apiName: my_gpt - source: hosted + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. diff --git a/scripts/generate_spec.sh b/scripts/generate_spec.sh index f8655842a..82618e74f 100755 --- a/scripts/generate_spec.sh +++ b/scripts/generate_spec.sh @@ -12,7 +12,9 @@ mkdir -p "${TMP_DIR}" wget -P "${TMP_DIR}" "${MAVEN_REPO_PATH}/${API_GATEWAY_VERSION}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" &> /dev/null tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir/openapi-ir.json" +# tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir-v2/openapi-ir.json" tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir/v2.json" +# tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir-v2/v2.json" tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/new-content/api-definition.yml" tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=2 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/deployment/manifest.yml" From f8802c4db72c1c12dc3e513926b7de76e018b9b1 Mon Sep 17 00:00:00 2001 From: Jacob Smith Date: Thu, 12 Sep 2024 15:12:26 -0300 Subject: [PATCH 3/4] format --- foundry/_core/auth_utils.py | 2 -- foundry/_core/foundry_token_auth_client.py | 1 - foundry/_core/page_iterator.py | 3 ++- foundry/v1/models/_search_objects_for_interface_request.py | 6 +++--- foundry/v2/models/_search_objects_for_interface_request.py | 6 +++--- 5 files changed, 8 insertions(+), 10 deletions(-) diff --git a/foundry/_core/auth_utils.py b/foundry/_core/auth_utils.py index 8ce02d4a3..4e1485cf1 100644 --- a/foundry/_core/auth_utils.py +++ b/foundry/_core/auth_utils.py @@ -22,7 +22,6 @@ class Token(ABC): - @property @abstractmethod def access_token(self) -> str: @@ -30,7 +29,6 @@ def access_token(self) -> str: class Auth(ABC): - @abstractmethod def get_token(self) -> "Token": pass diff --git a/foundry/_core/foundry_token_auth_client.py b/foundry/_core/foundry_token_auth_client.py index dbdb482e8..2fadcbf8f 100644 --- a/foundry/_core/foundry_token_auth_client.py +++ b/foundry/_core/foundry_token_auth_client.py @@ -27,7 +27,6 @@ class _UserToken(Token): - def __init__(self, token: str) -> None: self._token = token diff --git a/foundry/_core/page_iterator.py b/foundry/_core/page_iterator.py index 91692bd21..40f3cf813 100644 --- a/foundry/_core/page_iterator.py +++ b/foundry/_core/page_iterator.py @@ -26,7 +26,8 @@ class PageFunction(Generic[T], Protocol): def __call__( self, page_size: Optional[int], next_page_token: Optional[str] - ) -> Tuple[Optional[str], List[T]]: ... + ) -> Tuple[Optional[str], List[T]]: + ... class PageIterator(Generic[T]): diff --git a/foundry/v1/models/_search_objects_for_interface_request.py b/foundry/v1/models/_search_objects_for_interface_request.py index f8309579d..e16b2b62a 100644 --- a/foundry/v1/models/_search_objects_for_interface_request.py +++ b/foundry/v1/models/_search_objects_for_interface_request.py @@ -52,9 +52,9 @@ class SearchObjectsForInterfaceRequest(BaseModel): of properties specified in the value. """ - augmented_shared_property_types: Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] = ( - Field(alias="augmentedSharedPropertyTypes") - ) + augmented_shared_property_types: Dict[ + InterfaceTypeApiName, List[SharedPropertyTypeApiName] + ] = Field(alias="augmentedSharedPropertyTypes") """ A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object diff --git a/foundry/v2/models/_search_objects_for_interface_request.py b/foundry/v2/models/_search_objects_for_interface_request.py index c6abeedad..12ea765d0 100644 --- a/foundry/v2/models/_search_objects_for_interface_request.py +++ b/foundry/v2/models/_search_objects_for_interface_request.py @@ -52,9 +52,9 @@ class SearchObjectsForInterfaceRequest(BaseModel): of properties specified in the value. """ - augmented_shared_property_types: Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] = ( - Field(alias="augmentedSharedPropertyTypes") - ) + augmented_shared_property_types: Dict[ + InterfaceTypeApiName, List[SharedPropertyTypeApiName] + ] = Field(alias="augmentedSharedPropertyTypes") """ A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object From 9ed0bbe969adca38cc62ddedc8406ff670ffa9f0 Mon Sep 17 00:00:00 2001 From: svc-changelog Date: Thu, 12 Sep 2024 22:27:07 +0000 Subject: [PATCH 4/4] Add generated changelog entries --- changelog/@unreleased/pr-18.v2.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 changelog/@unreleased/pr-18.v2.yml diff --git a/changelog/@unreleased/pr-18.v2.yml b/changelog/@unreleased/pr-18.v2.yml new file mode 100644 index 000000000..3eb88f901 --- /dev/null +++ b/changelog/@unreleased/pr-18.v2.yml @@ -0,0 +1,5 @@ +type: feature +feature: + description: Update APIs + links: + - https://github.com/palantir/foundry-platform-python/pull/18