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
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -893,6 +893,7 @@ Namespace | Resource | Operation | HTTP request |
**Ontologies** | AttachmentProperty | [**read_attachment**](docs/v2/Ontologies/AttachmentProperty.md#read_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content |
**Ontologies** | AttachmentProperty | [**read_attachment_by_rid**](docs/v2/Ontologies/AttachmentProperty.md#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content |
**Ontologies** | CipherTextProperty | [**decrypt**](docs/v2/Ontologies/CipherTextProperty.md#decrypt) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt |
**Ontologies** | GeotemporalSeriesProperty | [**load_geotemporal_series_entries**](docs/v2/Ontologies/GeotemporalSeriesProperty.md#load_geotemporal_series_entries) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/geotemporalSeries/{property}/loadEntries |
**Ontologies** | LinkedObject | [**get_linked_object**](docs/v2/Ontologies/LinkedObject.md#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} |
**Ontologies** | LinkedObject | [**list_linked_objects**](docs/v2/Ontologies/LinkedObject.md#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} |
**Ontologies** | MediaReferenceProperty | [**get_media_content**](docs/v2/Ontologies/MediaReferenceProperty.md#get_media_content) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content |
Expand Down Expand Up @@ -2561,9 +2562,15 @@ Namespace | Name | Import |
**Ontologies** | [GetActionTypeByRidBatchRequest](docs/v2/Ontologies/models/GetActionTypeByRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeByRidBatchRequest` |
**Ontologies** | [GetActionTypeByRidBatchRequestElement](docs/v2/Ontologies/models/GetActionTypeByRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeByRidBatchRequestElement` |
**Ontologies** | [GetActionTypeByRidBatchResponse](docs/v2/Ontologies/models/GetActionTypeByRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeByRidBatchResponse` |
**Ontologies** | [GetActionTypeFullMetadataBatchRequest](docs/v2/Ontologies/models/GetActionTypeFullMetadataBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeFullMetadataBatchRequest` |
**Ontologies** | [GetActionTypeFullMetadataBatchRequestElement](docs/v2/Ontologies/models/GetActionTypeFullMetadataBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeFullMetadataBatchRequestElement` |
**Ontologies** | [GetActionTypeFullMetadataBatchResponse](docs/v2/Ontologies/models/GetActionTypeFullMetadataBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetActionTypeFullMetadataBatchResponse` |
**Ontologies** | [GetObjectTypeByRidBatchRequest](docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchRequest` |
**Ontologies** | [GetObjectTypeByRidBatchRequestElement](docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchRequestElement` |
**Ontologies** | [GetObjectTypeByRidBatchResponse](docs/v2/Ontologies/models/GetObjectTypeByRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchResponse` |
**Ontologies** | [GetObjectTypeFullMetadataBatchRequest](docs/v2/Ontologies/models/GetObjectTypeFullMetadataBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeFullMetadataBatchRequest` |
**Ontologies** | [GetObjectTypeFullMetadataBatchRequestElement](docs/v2/Ontologies/models/GetObjectTypeFullMetadataBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeFullMetadataBatchRequestElement` |
**Ontologies** | [GetObjectTypeFullMetadataBatchResponse](docs/v2/Ontologies/models/GetObjectTypeFullMetadataBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeFullMetadataBatchResponse` |
**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchRequest](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchRequest` |
**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement` |
**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchResponse](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchResponse` |
Expand Down
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.1740.1",
"minVersion": "1.1760.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
12 changes: 11 additions & 1 deletion docs-snippets-npm/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1513,9 +1513,14 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.\nontology = \"palantir\"\n# ActionTypeApiName | The name of the action type in the API.\naction_type = \"promote-employee\"\n# Optional[FoundryBranch] | The Foundry branch to load the action type definition from. If not specified, the default branch will be used.\nbranch = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n api_response = client.ontologies.ActionTypeFullMetadata.get(\n ontology, action_type, branch=branch, preview=preview\n )\n print(\"The get response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ActionTypeFullMetadata.get: %s\\n\" % e)"
}
],
"v2.getActionTypeFullMetadataBatch": [
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# List[GetActionTypeFullMetadataBatchRequestElement]\nrequests = None\n# Optional[FoundryBranch] | The Foundry branch to load the action type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n api_response = client.ontologies.ActionTypeFullMetadata.get_full_metadata_batch(\n ontology, requests=requests, branch=branch, preview=preview\n )\n print(\"The get_full_metadata_batch response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ActionTypeFullMetadata.get_full_metadata_batch: %s\\n\" % e)"
}
],
"v2.listActionTypesFullMetadata": [
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# Optional[FoundryBranch] | The Foundry branch to list the action types from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[List[ObjectTypeApiName]] | An set of object type api names that can be used to filter which actions are returned. Currently this only works for one object type, specifying more will cause the request to fail.\nobject_type_api_names = None\n# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details.\npage_size = None\n# Optional[PageToken]\npage_token = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n for action_type_full_metadata in client.ontologies.ActionTypeFullMetadata.list(\n ontology,\n branch=branch,\n object_type_api_names=object_type_api_names,\n page_size=page_size,\n page_token=page_token,\n preview=preview,\n ):\n pprint(action_type_full_metadata)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ActionTypeFullMetadata.list: %s\\n\" % e)"
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# Optional[FoundryBranch] | The Foundry branch to list the action types from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[List[ObjectTypeApiName]] | A set of object type API names that can be used to filter which actions are returned.\nobject_type_api_names = None\n# Optional[PageSize] | The desired size of the page to be returned. Defaults to 500. See [page sizes](https://palantir.com/docs/foundry/api/general/overview/paging/#page-sizes) for details.\npage_size = None\n# Optional[PageToken]\npage_token = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n for action_type_full_metadata in client.ontologies.ActionTypeFullMetadata.list(\n ontology,\n branch=branch,\n object_type_api_names=object_type_api_names,\n page_size=page_size,\n page_token=page_token,\n preview=preview,\n ):\n pprint(action_type_full_metadata)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ActionTypeFullMetadata.list: %s\\n\" % e)"
}
],
"v2.getAttachmentV2": [
Expand Down Expand Up @@ -1623,6 +1628,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**.\nobject_type = \"employee\"\n# Optional[FoundryBranch] | The Foundry branch to load the action type definition from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[bool] | When set to `true`, the `datasources` field on the returned object type is populated with the datasources backing it. Defaults to `false`.\ninclude_datasources = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n# Optional[SdkPackageRid] | The package rid of the generated SDK.\nsdk_package_rid = None\n# Optional[SdkVersion] | The version of the generated SDK.\nsdk_version = None\n\n\ntry:\n api_response = client.ontologies.Ontology.ObjectType.get_full_metadata(\n ontology,\n object_type,\n branch=branch,\n include_datasources=include_datasources,\n preview=preview,\n sdk_package_rid=sdk_package_rid,\n sdk_version=sdk_version,\n )\n print(\"The get_full_metadata response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ObjectType.get_full_metadata: %s\\n\" % e)"
}
],
"v2.getObjectTypeFullMetadataBatch": [
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# List[GetObjectTypeFullMetadataBatchRequestElement]\nrequests = None\n# Optional[FoundryBranch] | The Foundry branch to load the object type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n# Optional[bool] | A flag that will return all outgoing link types for each requested object type in that object type's `linkTypes`. When false or omitted, `linkTypes` is empty.\ninclude_link_types = None\n# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.\npreview = None\n\n\ntry:\n api_response = client.ontologies.Ontology.ObjectType.get_full_metadata_batch(\n ontology,\n requests=requests,\n branch=branch,\n include_link_types=include_link_types,\n preview=preview,\n )\n print(\"The get_full_metadata_batch response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ObjectType.get_full_metadata_batch: %s\\n\" % e)"
}
],
"v2.getOutgoingLinkTypeV2": [
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OntologyIdentifier\nontology = \"palantir\"\n# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager** application.\nobject_type = \"Employee\"\n# LinkTypeApiName | The API name of the outgoing link. To find the API name for your link type, check the **Ontology Manager**.\nlink_type = \"directReport\"\n# Optional[FoundryBranch] | The Foundry branch to get the outgoing link types for an object type from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.\nbranch = None\n\n\ntry:\n api_response = client.ontologies.Ontology.ObjectType.get_outgoing_link_type(\n ontology, object_type, link_type, branch=branch\n )\n print(\"The get_outgoing_link_type response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling ObjectType.get_outgoing_link_type: %s\\n\" % e)"
Expand Down
1 change: 1 addition & 0 deletions docs/v2/MediaSets/models/MediaSchema.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ The schema type of a media set, indicating what type of media items it can conta
| `"MULTIMODAL"` |
| `"SPREADSHEET"` |
| `"STREAMING_VIDEO"` |
| `"TILED_RASTER"` |
| `"VIDEO"` |
| `"EMAIL"` |

Expand Down
1 change: 1 addition & 0 deletions docs/v2/MediaSets/models/SpreadsheetDecodeFormat.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The format of a spreadsheet media item.

| **Value** |
| --------- |
| `"CSV"` |
| `"XLSX"` |


Expand Down
Loading