Skip to content

Latest commit

 

History

History
489 lines (363 loc) · 20 KB

OntologyObjectSet.md

File metadata and controls

489 lines (363 loc) · 20 KB

OntologyObjectSet

Method HTTP request Release Stage
aggregate POST /v2/ontologies/{ontology}/objectSets/aggregate Stable
create_temporary POST /v2/ontologies/{ontology}/objectSets/createTemporary Public Beta
get GET /v2/ontologies/{ontology}/objectSets/{objectSetRid} Private Beta
load POST /v2/ontologies/{ontology}/objectSets/loadObjects Stable
load_multiple_object_types POST /v2/ontologies/{ontology}/objectSets/loadObjectsMultipleObjectTypes Public Beta
load_objects_or_interfaces POST /v2/ontologies/{ontology}/objectSets/loadObjectsOrInterfaces Public Beta

aggregate

Aggregates the ontology objects present in the ObjectSet from the provided object set definition.

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

Parameters

Name Type Description Notes
ontology OntologyIdentifier The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
aggregation List[AggregationV2]
group_by List[AggregationGroupByV2]
object_set ObjectSet
accuracy Optional[AggregationAccuracyRequest] [optional]
artifact_repository Optional[ArtifactRepositoryRid] The repository associated with a marketplace installation. [optional]
package_name Optional[SdkPackageName] The package name of the generated SDK. [optional]

Return type

AggregateObjectsResponseV2

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology = "palantir"
# List[AggregationV2]
aggregation = None
# List[AggregationGroupByV2]
group_by = None
# ObjectSet
object_set = None
# Optional[AggregationAccuracyRequest]
accuracy = None
# Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation.
artifact_repository = None
# Optional[SdkPackageName] | The package name of the generated SDK.
package_name = None


try:
    api_response = client.ontologies.OntologyObjectSet.aggregate(
        ontology,
        aggregation=aggregation,
        group_by=group_by,
        object_set=object_set,
        accuracy=accuracy,
        artifact_repository=artifact_repository,
        package_name=package_name,
    )
    print("The aggregate response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling OntologyObjectSet.aggregate: %s\n" % e)

Authorization

See README

HTTP response details

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

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

create_temporary

Creates a temporary ObjectSet from the given definition. This ObjectSet expires after one hour.

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 OntologyIdentifier The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
object_set ObjectSet

Return type

CreateTemporaryObjectSetResponseV2

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology = "palantir"
# ObjectSet
object_set = {"type": "base", "objectType": "Employee"}


try:
    api_response = client.ontologies.OntologyObjectSet.create_temporary(
        ontology, object_set=object_set
    )
    print("The create_temporary response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling OntologyObjectSet.create_temporary: %s\n" % e)

Authorization

See README

HTTP response details

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

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

get

Gets the definition of the ObjectSet with the given RID.

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

Parameters

Name Type Description Notes
ontology OntologyIdentifier The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
object_set_rid ObjectSetRid The RID of the object set.

Return type

ObjectSet

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology = "palantir"
# ObjectSetRid | The RID of the object set.
object_set_rid = "ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053"


try:
    api_response = client.ontologies.OntologyObjectSet.get(ontology, object_set_rid)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling OntologyObjectSet.get: %s\n" % e)

Authorization

See README

HTTP response details

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

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

load

Load the ontology objects present in the ObjectSet from the provided object set definition.

For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects are available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.

Note that null value properties will not be returned.

Vector properties will not be returned unless included in the select parameter.

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

Parameters

Name Type Description Notes
ontology OntologyIdentifier The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
object_set ObjectSet
select List[SelectedPropertyApiName]
artifact_repository Optional[ArtifactRepositoryRid] The repository associated with a marketplace installation. [optional]
exclude_rid Optional[bool] A flag to exclude the retrieval of the __rid property. Setting this to true may improve performance of this endpoint for object types in OSV2. [optional]
order_by Optional[SearchOrderByV2] [optional]
package_name Optional[SdkPackageName] The package name of the generated SDK. [optional]
page_size Optional[PageSize] [optional]
page_token Optional[PageToken] [optional]

Return type

LoadObjectSetResponseV2

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology = "palantir"
# ObjectSet
object_set = {"type": "base", "objectType": "Employee"}
# List[SelectedPropertyApiName]
select = None
# Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation.
artifact_repository = None
# Optional[bool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2.
exclude_rid = None
# Optional[SearchOrderByV2]
order_by = None
# Optional[SdkPackageName] | The package name of the generated SDK.
package_name = None
# Optional[PageSize]
page_size = 10000
# Optional[PageToken]
page_token = None


try:
    api_response = client.ontologies.OntologyObjectSet.load(
        ontology,
        object_set=object_set,
        select=select,
        artifact_repository=artifact_repository,
        exclude_rid=exclude_rid,
        order_by=order_by,
        package_name=package_name,
        page_size=page_size,
        page_token=page_token,
    )
    print("The load response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling OntologyObjectSet.load: %s\n" % e)

Authorization

See README

HTTP response details

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

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

load_multiple_object_types

Load the ontology objects present in the ObjectSet from the provided object set definition. The resulting objects may be scoped to an object type, in which all the selected properties on the object type are returned, or scoped to an interface, in which only the object type properties that implement the properties of any interfaces in its scope are returned. For objects that are scoped to an interface in the result, a mapping from interface to object implementation is returned in order to interpret the objects as the interfaces that they implement.

For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects are available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.

Note that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey) will be prefixed with '$' instead of '__' as is the case in loadObjects.

Vector properties will not be returned unless included in the select parameter.

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

Parameters

Name Type Description Notes
ontology OntologyIdentifier The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
object_set ObjectSet
select List[SelectedPropertyApiName]
artifact_repository Optional[ArtifactRepositoryRid] The repository associated with a marketplace installation. [optional]
exclude_rid Optional[bool] A flag to exclude the retrieval of the $rid property. Setting this to true may improve performance of this endpoint for object types in OSV2. [optional]
order_by Optional[SearchOrderByV2] [optional]
package_name Optional[SdkPackageName] The package name of the generated SDK. [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]

Return type

LoadObjectSetV2MultipleObjectTypesResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology = "palantir"
# ObjectSet
object_set = {"type": "base", "objectType": "Employee"}
# List[SelectedPropertyApiName]
select = None
# Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation.
artifact_repository = None
# Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2.
exclude_rid = None
# Optional[SearchOrderByV2]
order_by = None
# Optional[SdkPackageName] | The package name of the generated SDK.
package_name = None
# Optional[PageSize]
page_size = 10000
# 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


try:
    api_response = client.ontologies.OntologyObjectSet.load_multiple_object_types(
        ontology,
        object_set=object_set,
        select=select,
        artifact_repository=artifact_repository,
        exclude_rid=exclude_rid,
        order_by=order_by,
        package_name=package_name,
        page_size=page_size,
        page_token=page_token,
        preview=preview,
    )
    print("The load_multiple_object_types response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling OntologyObjectSet.load_multiple_object_types: %s\n" % e)

Authorization

See README

HTTP response details

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

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

load_objects_or_interfaces

Load the ontology objects present in the ObjectSet from the provided object set definition. If the requested object set contains interfaces and the object can be viewed as an interface, it will contain the properties defined by the interface. If not, it will contain the properties defined by its object type. This allows directly loading all objects of an interface where all objects are viewed as the interface, for example.

Note that the result object set cannot contain a mix of objects with "interface" properties and "object type" properties. Attempting to load an object set like this will result in an error.

For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects are available, attempting to load another page will result in an ObjectsExceededLimit error being returned. There is no limit on Object Storage V2 backed objects.

Note that null value properties will not be returned. In addition, property metadata (rid, apiName, and primaryKey) will be prefixed with '$' instead of '__' as is the case in /loadObjects.

Vector properties will not be returned unless included in the select parameter.

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

Parameters

Name Type Description Notes
ontology OntologyIdentifier The API name of the ontology. To find the API name, use the List ontologies endpoint or check the Ontology Manager.
object_set ObjectSet
select List[SelectedPropertyApiName]
artifact_repository Optional[ArtifactRepositoryRid] The repository associated with a marketplace installation. [optional]
exclude_rid Optional[bool] A flag to exclude the retrieval of the $rid property. Setting this to true may improve performance of this endpoint for object types in OSV2. [optional]
order_by Optional[SearchOrderByV2] [optional]
package_name Optional[SdkPackageName] The package name of the generated SDK. [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]

Return type

LoadObjectSetV2ObjectsOrInterfacesResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

# OntologyIdentifier | The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**.
ontology = "palantir"
# ObjectSet
object_set = {"type": "base", "interfaceBase": "Person"}
# List[SelectedPropertyApiName]
select = None
# Optional[ArtifactRepositoryRid] | The repository associated with a marketplace installation.
artifact_repository = None
# Optional[bool] | A flag to exclude the retrieval of the `$rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2.
exclude_rid = None
# Optional[SearchOrderByV2]
order_by = None
# Optional[SdkPackageName] | The package name of the generated SDK.
package_name = None
# Optional[PageSize]
page_size = 10000
# 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


try:
    api_response = client.ontologies.OntologyObjectSet.load_objects_or_interfaces(
        ontology,
        object_set=object_set,
        select=select,
        artifact_repository=artifact_repository,
        exclude_rid=exclude_rid,
        order_by=order_by,
        package_name=package_name,
        page_size=page_size,
        page_token=page_token,
        preview=preview,
    )
    print("The load_objects_or_interfaces response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling OntologyObjectSet.load_objects_or_interfaces: %s\n" % e)

Authorization

See README

HTTP response details

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

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