Skip to content

Latest commit

 

History

History
264 lines (202 loc) · 11.2 KB

Action.md

File metadata and controls

264 lines (202 loc) · 11.2 KB

Action

Method HTTP request Release Stage
apply POST /v2/ontologies/{ontology}/actions/{action}/apply Stable
apply_batch POST /v2/ontologies/{ontology}/actions/{action}/applyBatch Stable
apply_with_overrides POST /v2/ontologies/{ontology}/actions/{action}/applyWithOverrides Private Beta

apply

Applies an action using the given parameters.

Changes to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible. Edits to objects or links in Object Storage V2 will be visible immediately after the action completes.

Note that a 200 HTTP status code only indicates that the request was received and processed by the server. See the validation result in the response body to determine if the action was applied successfully.

Note that parameter default values are not currently supported by this endpoint.

Parameters

Name Type Description Notes
ontology OntologyIdentifier
action ActionTypeApiName 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.
parameters Dict[ParameterId, Optional[DataValue]]
branch Optional[FoundryBranch] The Foundry branch to apply the action against. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. [optional]
options Optional[ApplyActionRequestOptions] [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]
transaction_id Optional[OntologyTransactionId] The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported. [optional]

Return type

SyncApplyActionResponseV2

Example

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"
# ActionTypeApiName | 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**.
action = "rename-employee"
# Dict[ParameterId, Optional[DataValue]]
parameters = {"id": 80060, "newName": "Anna Smith-Doe"}
# Optional[FoundryBranch] | The Foundry branch to apply the action against. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported.
branch = None
# Optional[ApplyActionRequestOptions]
options = None
# Optional[SdkPackageRid] | The package rid of the generated SDK.
sdk_package_rid = None
# Optional[SdkVersion] | The version of the generated SDK.
sdk_version = None
# Optional[OntologyTransactionId] | The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported.
transaction_id = None


try:
    api_response = client.ontologies.Action.apply(
        ontology,
        action,
        parameters=parameters,
        branch=branch,
        options=options,
        sdk_package_rid=sdk_package_rid,
        sdk_version=sdk_version,
        transaction_id=transaction_id,
    )
    print("The apply response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Action.apply: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 SyncApplyActionResponseV2 Success response. application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apply_batch

Applies multiple actions (of the same Action Type) using the given parameters.

Changes to objects or links stored in Object Storage V1 are eventually consistent and may take some time to be visible. Edits to objects or links in Object Storage V2 will be visible immediately after the action completes.

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 are not currently supported by this endpoint.

Parameters

Name Type Description Notes
ontology OntologyIdentifier
action ActionTypeApiName 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.
requests List[BatchApplyActionRequestItem]
branch Optional[FoundryBranch] The Foundry branch to apply the action against. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. [optional]
options Optional[BatchApplyActionRequestOptions] [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]

Return type

BatchApplyActionResponseV2

Example

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"
# ActionTypeApiName | 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**.
action = "rename-employee"
# List[BatchApplyActionRequestItem]
requests = [
    {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}},
    {"parameters": {"id": 80061, "newName": "Joe Bloggs"}},
]
# Optional[FoundryBranch] | The Foundry branch to apply the action against. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported.
branch = None
# Optional[BatchApplyActionRequestOptions]
options = None
# Optional[SdkPackageRid] | The package rid of the generated SDK.
sdk_package_rid = None
# Optional[SdkVersion] | The version of the generated SDK.
sdk_version = None


try:
    api_response = client.ontologies.Action.apply_batch(
        ontology,
        action,
        requests=requests,
        branch=branch,
        options=options,
        sdk_package_rid=sdk_package_rid,
        sdk_version=sdk_version,
    )
    print("The apply_batch response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Action.apply_batch: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 BatchApplyActionResponseV2 Success response. application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apply_with_overrides

Same as regular apply action operation, but allows specifying overrides for UniqueIdentifier and CurrentTime generated action parameters.

Parameters

Name Type Description Notes
ontology OntologyIdentifier
action ActionTypeApiName 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.
overrides ApplyActionOverrides
request ApplyActionRequestV2
branch Optional[FoundryBranch] The Foundry branch to apply the action against. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported. [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]
transaction_id Optional[OntologyTransactionId] The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported. [optional]

Return type

SyncApplyActionResponseV2

Example

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"
# ActionTypeApiName | 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**.
action = "rename-employee"
# ApplyActionOverrides
overrides = {
    "uniqueIdentifierLinkIdValues": {
        "fd28fa5c-3028-4eca-bdc8-3be2c7949cd9": "4efdb11f-c1e3-417c-89fb-2225118b65e3"
    },
    "actionExecutionTime": "2025-10-25T13:00:00Z",
}
# ApplyActionRequestV2
request = {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}
# Optional[FoundryBranch] | The Foundry branch to apply the action against. If not specified, the default branch is used. Branches are an experimental feature and not all workflows are supported.
branch = None
# Optional[SdkPackageRid] | The package rid of the generated SDK.
sdk_package_rid = None
# Optional[SdkVersion] | The version of the generated SDK.
sdk_version = None
# Optional[OntologyTransactionId] | The ID of an Ontology transaction to apply the action against. Transactions are an experimental feature and all workflows may not be supported.
transaction_id = None


try:
    api_response = client.ontologies.Action.apply_with_overrides(
        ontology,
        action,
        overrides=overrides,
        request=request,
        branch=branch,
        sdk_package_rid=sdk_package_rid,
        sdk_version=sdk_version,
        transaction_id=transaction_id,
    )
    print("The apply_with_overrides response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Action.apply_with_overrides: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 SyncApplyActionResponseV2 Success response. application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]