Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-snippets-npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"sls": {
"dependencies": {
"com.palantir.foundry.api:api-gateway": {
"minVersion": "1.1485.0",
"minVersion": "1.1494.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
21 changes: 18 additions & 3 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/v1/Core/models/VoidType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# VoidType

VoidType

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**type** | Literal["void"] | 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)
1 change: 1 addition & 0 deletions docs/v1/Ontologies/models/QueryDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ DateType | date
OntologyInterfaceObjectType | interfaceObject
QueryStructType | struct
QuerySetType | set
VoidType | void
StringType | string
EntrySetType | entrySet
DoubleType | double
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# ParameterBinaryValue
# VoidType

A binary parameter value.
VoidType

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**value** | bytes | Yes | |
**type** | Literal["binary"] | Yes | None |
**type** | Literal["void"] | 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)
18 changes: 13 additions & 5 deletions docs/v2/Functions/Query.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Executes a Query using the given parameters. By default, this executes the lates

This endpoint is maintained for backward compatibility only.

For all new implementations, use the `streamingExecute` endpoint, which supports all function types
For all new implementations, use the `streamingExecute` endpoint, which supports all function types
and provides enhanced functionality.


Expand All @@ -24,11 +24,12 @@ Name | Type | Description | Notes |
**query_api_name** | QueryApiName | | |
**parameters** | Dict[ParameterId, Optional[DataValue]] | | |
**attribution** | Optional[Attribution] | | [optional] |
**branch** | Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
**trace_parent** | Optional[TraceParent] | | [optional] |
**trace_state** | Optional[TraceState] | | [optional] |
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] |
**version** | Optional[FunctionVersion] | | [optional] |
**version** | Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. | [optional] |

### Return type
**ExecuteQueryResponse**
Expand All @@ -48,6 +49,8 @@ query_api_name = None
parameters = None
# Optional[Attribution]
attribution = None
# Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch.
branch = "ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None
# Optional[TraceParent]
Expand All @@ -56,7 +59,7 @@ trace_parent = None
trace_state = None
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.
transaction_id = None
# Optional[FunctionVersion]
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
version = None


Expand All @@ -65,6 +68,7 @@ try:
query_api_name,
parameters=parameters,
attribution=attribution,
branch=branch,
preview=preview,
trace_parent=trace_parent,
trace_state=trace_state,
Expand Down Expand Up @@ -294,12 +298,13 @@ Name | Type | Description | Notes |
**query_api_name** | QueryApiName | | |
**parameters** | Dict[ParameterId, Optional[DataValue]] | | |
**attribution** | Optional[Attribution] | | [optional] |
**branch** | Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. | [optional] |
**ontology** | Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
**trace_parent** | Optional[TraceParent] | | [optional] |
**trace_state** | Optional[TraceState] | | [optional] |
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported. | [optional] |
**version** | Optional[FunctionVersion] | | [optional] |
**version** | Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. | [optional] |

### Return type
**bytes**
Expand All @@ -319,6 +324,8 @@ query_api_name = None
parameters = None
# Optional[Attribution]
attribution = None
# Optional[FoundryBranch] | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch.
branch = "ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252"
# Optional[OntologyIdentifier] | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function.
ontology = "example-ontology"
# Optional[PreviewMode] | Enables the use of preview functionality.
Expand All @@ -329,7 +336,7 @@ trace_parent = None
trace_state = None
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and all workflows may not be supported.
transaction_id = None
# Optional[FunctionVersion]
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
version = None


Expand All @@ -338,6 +345,7 @@ try:
query_api_name,
parameters=parameters,
attribution=attribution,
branch=branch,
ontology=ontology,
preview=preview,
trace_parent=trace_parent,
Expand Down
3 changes: 2 additions & 1 deletion docs/v2/Functions/models/ExecuteQueryRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ ExecuteQueryRequest
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | |
**version** | Optional[FunctionVersion] | No | |
**version** | Optional[FunctionVersion] | No | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. |
**branch** | Optional[FoundryBranch] | No | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
1 change: 1 addition & 0 deletions docs/v2/Functions/models/QueryDataType.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This discriminator class uses the `type` field to differentiate between classes.
DateType | date
QueryStructType | struct
QuerySetType | set
VoidType | void
StringType | string
DoubleType | double
IntegerType | integer
Expand Down
3 changes: 2 additions & 1 deletion docs/v2/Functions/models/StreamingExecuteQueryRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ StreamingExecuteQueryRequest
| ------------ | ------------- | ------------- | ------------- |
**ontology** | Optional[OntologyIdentifier] | No | Optional ontology identifier (RID or API name). When provided, executes an ontology-scoped function. When omitted, executes a global function. |
**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | |
**version** | Optional[FunctionVersion] | No | |
**version** | Optional[FunctionVersion] | No | The version of the query to execute. When used with `branch`, the specified version must exist on the branch. |
**branch** | Optional[FoundryBranch] | No | The Foundry branch to execute the query from. If not specified, the default branch is used. When provided without `version`, the latest version on this branch is used. When provided with `version`, the specified version must exist on the branch. |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
129 changes: 129 additions & 0 deletions docs/v2/MediaSets/MediaSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Release Stage |
[**calculate**](#calculate) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform/imagery/thumbnail/calculate | Private Beta |
[**commit**](#commit) | **POST** /v2/mediasets/{mediaSetRid}/transactions/{transactionId}/commit | Public Beta |
[**create**](#create) | **POST** /v2/mediasets/{mediaSetRid}/transactions | Public Beta |
[**get**](#get) | **GET** /v2/mediasets/{mediaSetRid} | Public Beta |
[**get_result**](#get_result) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId}/result | Public Beta |
[**get_rid_by_path**](#get_rid_by_path) | **GET** /v2/mediasets/{mediaSetRid}/items/getRidByPath | Public Beta |
[**get_status**](#get_status) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transformationJobs/{transformationJobId} | Public Beta |
Expand All @@ -14,6 +15,7 @@ Method | HTTP request | Release Stage |
[**read**](#read) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/content | Public Beta |
[**read_original**](#read_original) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/original | Public Beta |
[**reference**](#reference) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference | Public Beta |
[**register**](#register) | **POST** /v2/mediasets/{mediaSetRid}/items/register | Public Beta |
[**retrieve**](#retrieve) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform/imagery/thumbnail/retrieve | Private Beta |
[**transform**](#transform) | **POST** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/transform | Public Beta |
[**upload**](#upload) | **POST** /v2/mediasets/{mediaSetRid}/items | Public Beta |
Expand Down Expand Up @@ -242,6 +244,57 @@ See [README](../../../README.md#authorization)

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **get**
Gets information about the media set.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**media_set_rid** | MediaSetRid | | |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |

### Return type
**GetMediaSetResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# MediaSetRid
media_set_rid = None
# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.
preview = None


try:
api_response = client.media_sets.MediaSet.get(media_set_rid, preview=preview)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling MediaSet.get: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | GetMediaSetResponse | | application/json |

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **get_result**
Gets the result of a completed transformation job. Returns the transformed media content as binary data.
This endpoint will return an error if the transformation job has not completed successfully.
Expand Down Expand Up @@ -733,6 +786,82 @@ See [README](../../../README.md#authorization)

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **register**
Registers a media item that currently resides in a federated media store. Registration will validate the item
against the media set's schema and perform initial metadata extraction.
This endpoint is only applicable for federated media sets.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**media_set_rid** | MediaSetRid | | |
**physical_item_name** | str | The relative path within the federated media store where the media item exists. | |
**branch_name** | Optional[BranchName] | Specifies the specific branch by name to which this media item will be registered. | [optional] |
**media_item_path** | Optional[MediaItemPath] | | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**transaction_id** | Optional[TransactionId] | The id of the transaction associated with this request. Required for transactional media sets. | [optional] |
**view_rid** | Optional[MediaSetViewRid] | Specifies the specific view by rid to which this media item will be registered. | [optional] |

### Return type
**RegisterMediaItemResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# MediaSetRid
media_set_rid = None
# str | The relative path within the federated media store where the media item exists.
physical_item_name = None
# Optional[BranchName] | Specifies the specific branch by name to which this media item will be registered.
branch_name = None
# Optional[MediaItemPath]
media_item_path = None
# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.
preview = None
# Optional[TransactionId] | The id of the transaction associated with this request. Required for transactional media sets.
transaction_id = None
# Optional[MediaSetViewRid] | Specifies the specific view by rid to which this media item will be registered.
view_rid = None


try:
api_response = client.media_sets.MediaSet.register(
media_set_rid,
physical_item_name=physical_item_name,
branch_name=branch_name,
media_item_path=media_item_path,
preview=preview,
transaction_id=transaction_id,
view_rid=view_rid,
)
print("The register response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling MediaSet.register: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | RegisterMediaItemResponse | | application/json |

[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md)

# **retrieve**
Retrieves a successfully calculated thumbnail for a given image.

Expand Down
13 changes: 13 additions & 0 deletions docs/v2/MediaSets/models/BatchTransactionsTransactionPolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# BatchTransactionsTransactionPolicy

All writes must be part of a transaction. Transactions are branch-scoped and created by calling
create transaction. Writes are not visible until commit transaction is called.


## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**type** | Literal["batchTransactions"] | 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)
15 changes: 15 additions & 0 deletions docs/v2/MediaSets/models/GetMediaSetResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# GetMediaSetResponse

Information about a media set.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**rid** | MediaSetRid | Yes | |
**media_schema** | MediaSchema | Yes | |
**default_branch_name** | BranchName | Yes | |
**transaction_policy** | TransactionPolicy | Yes | |
**paths_required** | bool | Yes | Whether media items in this media set require paths. |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
18 changes: 18 additions & 0 deletions docs/v2/MediaSets/models/MediaSchema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# MediaSchema

The schema type of a media set, indicating what type of media items it can contain.

| **Value** |
| --------- |
| `"AUDIO"` |
| `"DICOM"` |
| `"DOCUMENT"` |
| `"IMAGERY"` |
| `"MODEL_3D"` |
| `"MULTIMODAL"` |
| `"SPREADSHEET"` |
| `"VIDEO"` |
| `"EMAIL"` |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
13 changes: 13 additions & 0 deletions docs/v2/MediaSets/models/NoTransactionsTransactionPolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# NoTransactionsTransactionPolicy

Writes are not part of a transaction and are immediately visible.
Calls to create transaction or commit transaction will error.


## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**type** | Literal["noTransactions"] | 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)
12 changes: 12 additions & 0 deletions docs/v2/MediaSets/models/RegisterMediaItemRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# RegisterMediaItemRequest

Request to register a media item from a federated store.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**physical_item_name** | str | Yes | The relative path within the federated media store where the media item exists. |
**media_item_path** | Optional[MediaItemPath] | No | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
Loading