Skip to content

Latest commit

 

History

History
218 lines (155 loc) · 9.34 KB

Action.md

File metadata and controls

218 lines (155 loc) · 9.34 KB

Action

Method HTTP request Release Stage
apply POST /v1/ontologies/{ontologyRid}/actions/{actionType}/apply Stable
apply_batch POST /v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch Stable
validate POST /v1/ontologies/{ontologyRid}/actions/{actionType}/validate Stable

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

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-write.

Parameters

Name Type Description Notes
ontology_rid OntologyRid The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.
action_type 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]]

Return type

ApplyActionResponse

Example

from foundry_sdk.v1 import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"
# 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_type = "rename-employee"
# Dict[ParameterId, Optional[DataValue]]
parameters = {"id": 80060, "newName": "Anna Smith-Doe"}


try:
    api_response = client.ontologies.Action.apply(ontology_rid, action_type, parameters=parameters)
    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 ApplyActionResponse 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 parameter default values and notifications are not currently supported by this endpoint.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read api:ontologies-write.

Parameters

Name Type Description Notes
ontology_rid OntologyRid The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.
action_type 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[ApplyActionRequest]

Return type

BatchApplyActionResponse

Example

from foundry_sdk.v1 import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"
# 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_type = "rename-employee"
# List[ApplyActionRequest]
requests = [
    {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}},
    {"parameters": {"id": 80061, "newName": "Joe Bloggs"}},
]


try:
    api_response = client.ontologies.Action.apply_batch(
        ontology_rid, action_type, requests=requests
    )
    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 BatchApplyActionResponse Success response. application/json

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

validate

Validates if an action can be run with the given set of parameters. The response contains the evaluation of parameters and submission criteria that determine if the request is VALID or INVALID. For performance reasons, validations will not consider existing objects or other data in Foundry. For example, the uniqueness of a primary key or the existence of a user ID will not be checked. Note that parameter default values are not currently supported by this endpoint. Unspecified parameters will be given a default value of null.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:ontologies-read.

Parameters

Name Type Description Notes
ontology_rid OntologyRid The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the List ontologies endpoint or check the Ontology Manager.
action_type ActionTypeApiName The API name of the action to validate. To find the API name for your action, use the List action types endpoint or check the Ontology Manager.
parameters Dict[ParameterId, Optional[DataValue]]

Return type

ValidateActionResponse

Example

from foundry_sdk.v1 import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyRid | The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367"
# ActionTypeApiName | The API name of the action to validate. To find the API name for your action, use the **List action types** endpoint or check the **Ontology Manager**.
action_type = "rename-employee"
# Dict[ParameterId, Optional[DataValue]]
parameters = {
    "id": "2",
    "firstName": "Chuck",
    "lastName": "Jones",
    "age": 17,
    "date": "2021-05-01",
    "numbers": [1, 2, 3],
    "hasObjectSet": True,
    "objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623",
    "reference": "Chuck",
    "percentage": 41.3,
    "differentObjectId": "2",
}


try:
    api_response = client.ontologies.Action.validate(
        ontology_rid, action_type, parameters=parameters
    )
    print("The validate response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Action.validate: %s\n" % e)

Authorization

See README

HTTP response details

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

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