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
50 changes: 50 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.1630.0",
"minVersion": "1.1642.1",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
24 changes: 17 additions & 7 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

53 changes: 53 additions & 0 deletions docs/v2/Admin/Marking.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Release Stage |
[**get**](#get) | **GET** /v2/admin/markings/{markingId} | Stable |
[**get_batch**](#get_batch) | **POST** /v2/admin/markings/getBatch | Stable |
[**list**](#list) | **GET** /v2/admin/markings | Stable |
[**parse_classifications**](#parse_classifications) | **POST** /v2/admin/markings/parseClassifications | Public Beta |
[**replace**](#replace) | **PUT** /v2/admin/markings/{markingId} | Stable |

# **create**
Expand Down Expand Up @@ -220,6 +221,58 @@ 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)

# **parse_classifications**
Parses classification marking strings (e.g. 'S//NF') into their component marking IDs. Strings that cannot be parsed are returned in 'errors' with a human-readable message.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**classification_strings** | List[str] | The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted. | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ParseClassificationsResponse**

### Example

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

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

# List[str] | The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted.
classification_strings = ["MTS//MNF", "MU"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Marking.parse_classifications(
classification_strings=classification_strings, preview=preview
)
print("The parse_classifications response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Marking.parse_classifications: %s\n" % e)

```



### Authorization

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

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

# **replace**
Replace the Marking with the specified id.

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

ParseClassificationsRequest

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**classification_strings** | List[str] | Yes | The classification strings to parse, e.g. 'S//NF'. Duplicate entries are ignored. At most 1000 entries are accepted. |


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

ParseClassificationsResponse

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**parsed** | Dict[str, List[MarkingId]] | Yes | Map of valid classification strings to their component marking IDs. Strings that could not be parsed are absent from this map and appear in 'errors' instead. |
**errors** | Dict[str, str] | Yes | Map of classification strings that could not be parsed to a human-readable error message. |


[[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: 6 additions & 6 deletions docs/v2/Functions/Query.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Name | Type | Description | Notes |
**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] |
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. | [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
Expand Down Expand Up @@ -58,7 +58,7 @@ preview = None
trace_parent = None
# Optional[TraceState]
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.
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported.
transaction_id = None
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
version = None
Expand Down Expand Up @@ -116,7 +116,7 @@ Name | Type | Description | Notes |
**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] |
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. | [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
Expand Down Expand Up @@ -147,7 +147,7 @@ preview = None
trace_parent = None
# Optional[TraceState]
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.
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported.
transaction_id = None
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
version = None
Expand Down Expand Up @@ -394,7 +394,7 @@ Name | Type | Description | Notes |
**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] |
**transaction_id** | Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported. | [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
Expand Down Expand Up @@ -425,7 +425,7 @@ preview = None
trace_parent = None
# Optional[TraceState]
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.
# Optional[TransactionId] | The ID of a transaction to read from. Transactions are an experimental feature and not all workflows may be supported.
transaction_id = None
# Optional[FunctionVersion] | The version of the query to execute. When used with `branch`, the specified version must exist on the branch.
version = None
Expand Down
84 changes: 84 additions & 0 deletions docs/v2/Ontologies/ActionType.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Release Stage |
[**get_by_rid**](#get_by_rid) | **GET** /v2/ontologies/{ontology}/actionTypes/byRid/{actionTypeRid} | Stable |
[**get_by_rid_batch**](#get_by_rid_batch) | **POST** /v2/ontologies/{ontology}/actionTypes/getByRidBatch | Public Beta |
[**list**](#list) | **GET** /v2/ontologies/{ontology}/actionTypes | Stable |
[**search**](#search) | **POST** /v2/ontologies/{ontology}/actionTypes/search | Private Beta |

# **get**
Gets a specific action type with the given API name.
Expand Down Expand Up @@ -242,3 +243,86 @@ 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)

# **search**
Search for action types in the given Ontology that match the provided filters. Results are returned by
relevance of the match unless an explicit `orderBy` is provided.

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. Search results are eventually
consistent with the latest Ontology version and may lag slightly behind the last Ontology modification.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**ontology** | OntologyIdentifier | | |
**branch** | Optional[FoundryBranch] | The Foundry branch to search the action types from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. | [optional] |
**fuzziness** | Optional[ActionTypeFuzziness] | | [optional] |
**order_by** | Optional[SearchActionTypesOrderByV2] | | [optional] |
**page_size** | Optional[PageSize] | | [optional] |
**page_token** | Optional[PageToken] | | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**where** | Optional[ActionTypeSearchJsonQueryV2] | | [optional] |

### Return type
**SearchActionTypesResponseV2**

### Example

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

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

# OntologyIdentifier
ontology = "palantir"
# Optional[FoundryBranch] | The Foundry branch to search the action types from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported.
branch = None
# Optional[ActionTypeFuzziness]
fuzziness = None
# Optional[SearchActionTypesOrderByV2]
order_by = None
# Optional[PageSize]
page_size = None
# Optional[PageToken]
page_token = None
# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.
preview = None
# Optional[ActionTypeSearchJsonQueryV2]
where = {"type": "actionTypeDisplayName", "value": {"type": "contains", "value": "promote"}}


try:
api_response = client.ontologies.Ontology.ActionType.search(
ontology,
branch=branch,
fuzziness=fuzziness,
order_by=order_by,
page_size=page_size,
page_token=page_token,
preview=preview,
where=where,
)
print("The search response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling ActionType.search: %s\n" % e)

```



### Authorization

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

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

8 changes: 8 additions & 0 deletions docs/v2/Ontologies/MediaReferenceProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Name | Type | Description | Notes |
**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | |
**primary_key** | PropertyValueEscapedString | The primary key of the object with the media reference property. | |
**property** | PropertyApiName | The API name of the media reference property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to read from. If not specified, the default branch will be used. | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] |
Expand All @@ -42,6 +43,8 @@ object_type = "employee"
primary_key = 50030
# PropertyApiName | The API name of the media reference property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint.
property = "profile_picture"
# Optional[FoundryBranch] | The Foundry branch to read from. If not specified, the default branch will be used.
branch = None
# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.
preview = None
# Optional[SdkPackageRid] | The package rid of the generated SDK.
Expand All @@ -56,6 +59,7 @@ try:
object_type,
primary_key,
property,
branch=branch,
preview=preview,
sdk_package_rid=sdk_package_rid,
sdk_version=sdk_version,
Expand Down Expand Up @@ -92,6 +96,7 @@ Name | Type | Description | Notes |
**object_type** | ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. | |
**primary_key** | PropertyValueEscapedString | The primary key of the object with the media reference property. | |
**property** | PropertyApiName | The API name of the media reference backed property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint. | |
**branch** | Optional[FoundryBranch] | The Foundry branch to read from. If not specified, the default branch will be used. | [optional] |
**preview** | Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode. | [optional] |
**sdk_package_rid** | Optional[SdkPackageRid] | The package rid of the generated SDK. | [optional] |
**sdk_version** | Optional[SdkVersion] | The version of the generated SDK. | [optional] |
Expand All @@ -116,6 +121,8 @@ object_type = "employee"
primary_key = 50030
# PropertyApiName | The API name of the media reference backed property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint.
property = None
# Optional[FoundryBranch] | The Foundry branch to read from. If not specified, the default branch will be used.
branch = None
# Optional[PreviewMode] | A boolean flag that, when set to true, enables the use of beta features in preview mode.
preview = None
# Optional[SdkPackageRid] | The package rid of the generated SDK.
Expand All @@ -130,6 +137,7 @@ try:
object_type,
primary_key,
property,
branch=branch,
preview=preview,
sdk_package_rid=sdk_package_rid,
sdk_version=sdk_version,
Expand Down
Loading