Skip to content
Open
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
54 changes: 54 additions & 0 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.1416.1",
"minVersion": "1.1429.1",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
19 changes: 12 additions & 7 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/v1/Core/models/UnsupportedType.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ UnsupportedType
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**unsupported_type** | str | Yes | |
**params** | Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] | Yes | |
**type** | Literal["unsupported"] | Yes | None |


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

UnsupportedTypeParamKey

## Type
```python
str
```


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

UnsupportedTypeParamValue

## Type
```python
str
```


[[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/PropertyValue.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Represents the value of a property in the following format.
| Integer | number | `238940` |
| Long | string | `"58319870951433"` |
| [MediaReference](https://palantir.com/docs/foundry/api/v2/ontologies-v2-resources/media-reference-properties/media-reference-property-basics/)| JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` |
| Secured Property Value | JSON encoded `SecuredPropertyValue` object | `{"value": 10, "propertySecurityIndex" : 5}` |
| Short | number | `8739` |
| String | string | `"Call me Ishmael"` |
| Struct | JSON object of struct field API name -> value | {"firstName": "Alex", "lastName": "Karp"} |
Expand Down
1 change: 1 addition & 0 deletions docs/v2/Core/models/UnsupportedType.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ UnsupportedType
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**unsupported_type** | str | Yes | |
**params** | Dict[UnsupportedTypeParamKey, UnsupportedTypeParamValue] | Yes | |
**type** | Literal["unsupported"] | Yes | None |


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

UnsupportedTypeParamKey

## Type
```python
str
```


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

UnsupportedTypeParamValue

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
2 changes: 1 addition & 1 deletion docs/v2/Datasets/models/ViewBackingDataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ One of the Datasets backing a View.
## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**branch** | BranchName | Yes | |
**branch** | Optional[BranchName] | No | The branch of the backing dataset. If not specified, defaults to the branch of the View. |
**dataset_rid** | DatasetRid | Yes | |


Expand Down
61 changes: 61 additions & 0 deletions docs/v2/MediaSets/MediaSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Method | HTTP request | Release Stage |
[**create**](#create) | **POST** /v2/mediasets/{mediaSetRid}/transactions | Public Beta |
[**get_rid_by_path**](#get_rid_by_path) | **GET** /v2/mediasets/{mediaSetRid}/items/getRidByPath | Public Beta |
[**info**](#info) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid} | Public Beta |
[**metadata**](#metadata) | **GET** /v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata | Public Beta |
[**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 |
Expand Down Expand Up @@ -367,6 +368,66 @@ 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)

# **metadata**
Gets detailed metadata about the media item, including type-specific information
such as dimensions for images, duration for audio/video, page count for documents, etc.


### Parameters

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

### Return type
**MediaItemMetadata**

### 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 | The RID of the media set.
media_set_rid = None
# MediaItemRid | The RID of the media item.
media_item_rid = None
# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.
preview = None
# Optional[MediaItemReadToken]
read_token = None


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

```



### Authorization

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

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | MediaItemMetadata | | 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)

# **read**
Gets the content of a media item.

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

An affine transformation for geo-referencing.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**x_translate** | Optional[float] | No | |
**x_scale** | Optional[float] | No | |
**x_shear** | Optional[float] | No | |
**y_translate** | Optional[float] | No | |
**y_shear** | Optional[float] | No | |
**y_scale** | Optional[float] | No | |


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

The format of an audio media item.

| **Value** |
| --------- |
| `"FLAC"` |
| `"MP2"` |
| `"MP3"` |
| `"MP4"` |
| `"NIST_SPHERE"` |
| `"OGG"` |
| `"WAV"` |
| `"WEBM"` |


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

Metadata for audio media items.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**format** | AudioDecodeFormat | Yes | |
**specification** | AudioSpecification | Yes | |
**size_bytes** | int | Yes | The size of the media item in bytes. |
**type** | Literal["audio"] | 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)
13 changes: 13 additions & 0 deletions docs/v2/MediaSets/models/AudioSpecification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AudioSpecification

Technical specifications for audio media items.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**bit_rate** | int | Yes | Approximate (average) bits per second of the audio, rounded up in case of a fractional average bits per second. |
**duration_seconds** | float | Yes | Approximate duration of the audio, in seconds with up to two decimal digits (rounded up). |
**number_of_channels** | Optional[int] | No | Number of audio channels in the audio stream. |


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

Information about a band in an image.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data_type** | Optional[DataType] | No | |
**color_interpretation** | Optional[ColorInterpretation] | No | |
**palette_interpretation** | Optional[PaletteInterpretation] | No | |
**unit_interpretation** | Optional[UnitInterpretation] | No | |


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

The color interpretation of a band.

| **Value** |
| --------- |
| `"UNDEFINED"` |
| `"GRAY"` |
| `"PALETTE_INDEX"` |
| `"RED"` |
| `"GREEN"` |
| `"BLUE"` |
| `"ALPHA"` |
| `"HUE"` |
| `"SATURATION"` |
| `"LIGHTNESS"` |
| `"CYAN"` |
| `"MAGENTA"` |
| `"YELLOW"` |
| `"BLACK"` |
| `"Y_CB_CR_SPACE_Y"` |
| `"Y_CB_CR_SPACE_CB"` |
| `"Y_CB_CR_SPACE_CR"` |


[[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/CommonDicomDataElements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CommonDicomDataElements

Common DICOM data elements.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**number_frames** | Optional[int] | No | The number of frames in the DICOM file. |
**modality** | Optional[Modality] | No | |
**patient_id** | Optional[str] | No | The patient ID. |
**study_id** | Optional[str] | No | The study ID. |
**study_uid** | Optional[str] | No | The study UID. |
**series_uid** | Optional[str] | No | The series UID. |
**study_time** | Optional[datetime] | No | The study time. |
**series_time** | Optional[datetime] | No | The series time. |


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

The coordinate reference system for geo-referenced imagery.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**wkt** | Optional[str] | No | The Well-Known Text representation of the CRS. |


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

The data type of a band.

| **Value** |
| --------- |
| `"UNDEFINED"` |
| `"BYTE"` |
| `"UINT16"` |
| `"INT16"` |
| `"UINT32"` |
| `"INT32"` |
| `"FLOAT32"` |
| `"FLOAT64"` |
| `"COMPLEX_INT16"` |
| `"COMPLEX_INT32"` |
| `"COMPLEX_FLOAT32"` |
| `"COMPLEX_FLOAT64"` |
| `"UINT64"` |
| `"INT64"` |
| `"INT8"` |


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

The key of a DICOM data element.

## Type
```python
str
```


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

Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**meta_information** | DicomMetaInformation | Yes | |
**media_type** | DicomMediaType | Yes | |
**common_data_elements** | CommonDicomDataElements | Yes | |
**other_data_elements** | Dict[DicomDataElementKey, Any] | Yes | The data elements for a particular DICOM file outside of the media contained within it and the data elements within the commonDataElements field. |
**size_bytes** | int | Yes | The size of the media item in bytes. |
**type** | Literal["dicom"] | 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)
13 changes: 13 additions & 0 deletions docs/v2/MediaSets/models/DicomMediaType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DicomMediaType

The type of DICOM media.

| **Value** |
| --------- |
| `"IMAGE"` |
| `"MULTI_FRAME_IMAGE"` |
| `"VIDEO"` |
| `"STRUCTURED_REPORT"` |


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

DICOM meta information.

## Type
```python
DicomMetaInformationV1
```


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

DICOM meta information version 1.

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**media_storage_sop** | str | Yes | The Media Storage SOP (Service-Object Pair) Class UID, which identifies the type of DICOM object stored (e.g., CT Image, MR Image). |
**media_storage_sop_instance** | str | Yes | The Media Storage SOP Instance UID. |
**transfer_syntax** | str | Yes | The Transfer Syntax UID, which specifies how the DICOM data is encoded (e.g., compression method, byte ordering). |
**type** | Literal["v1"] | 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)
Loading