Skip to content

TimeSeriesValueBankProperty.md

Latest commit

 

History

History
161 lines (121 loc) · 7.19 KB

TimeSeriesValueBankProperty.md

File metadata and controls

161 lines (121 loc) · 7.19 KB

TimeSeriesValueBankProperty

Method HTTP request Release Stage
get_latest_value GET /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{propertyName}/latestValue Public Beta
stream_values POST /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamValues Public Beta

get_latest_value

Get the latest value of a property backed by a timeseries. If a specific geotime series integration has both a history and a live integration, we will give precedence to the live integration.

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: 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_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 timeseries property.
property_name PropertyApiName The API name of the timeseries property. To find the API name for your property value bank property, check the Ontology Manager or use the Get object type endpoint.
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

Optional[TimeseriesEntry]

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"
# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**.
object_type = "employee"
# PropertyValueEscapedString | The primary key of the object with the timeseries property.
primary_key = 50030
# PropertyApiName | The API name of the timeseries property. To find the API name for your property value bank property, check the **Ontology Manager** or use the **Get object type** endpoint.
property_name = "performance"
# 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.TimeSeriesValueBankProperty.get_latest_value(
        ontology,
        object_type,
        primary_key,
        property_name,
        artifact_repository=artifact_repository,
        package_name=package_name,
    )
    print("The get_latest_value response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TimeSeriesValueBankProperty.get_latest_value: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Optional[TimeseriesEntry] Success response. application/json

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

stream_values

Stream all of the points of a time series property (this includes geotime series references).

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: 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_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 time series property.
property PropertyApiName The API name of the time series backed property. To find the API name, check the Ontology Manager or use the Get object type endpoint.
artifact_repository Optional[ArtifactRepositoryRid] The repository associated with a marketplace installation. [optional]
package_name Optional[SdkPackageName] The package name of the generated SDK. [optional]
range Optional[TimeRange] [optional]

Return type

bytes

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"
# ObjectTypeApiName | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**.
object_type = "employee"
# PropertyValueEscapedString | The primary key of the object with the time series property.
primary_key = 50030
# PropertyApiName | The API name of the time series backed property. To find the API name, check the **Ontology Manager** or use the **Get object type** endpoint.
property = 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
# Optional[TimeRange]
range = {
    "type": "relative",
    "startTime": {"when": "BEFORE", "value": 5, "unit": "MONTHS"},
    "endTime": {"when": "BEFORE", "value": 1, "unit": "MONTHS"},
}


try:
    api_response = client.ontologies.TimeSeriesValueBankProperty.stream_values(
        ontology,
        object_type,
        primary_key,
        property,
        artifact_repository=artifact_repository,
        package_name=package_name,
        range=range,
    )
    print("The stream_values response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling TimeSeriesValueBankProperty.stream_values: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 bytes Success response. /

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