지리 시계열 관측값 조회(Load Geotemporal Series Entries) (V2)

객체의 지리 시계열 참조에서 지정한 시간 범위의 관측값을 페이지 단위로 조회합니다. 이 API는 미리보기 기능이며 변경되거나 제거될 수 있습니다. 호출할 때 preview=true를 지정합니다.

콜드 스토리지만 활성화한 지리 시계열 통합은 지원하지 않습니다. range.startTime과 range.endTime을 모두 지정하며 시작 시각은 포함하고 끝 시각은 제외합니다.

각 항목은 속성 API 이름과 값의 맵입니다. time과 position은 항상 포함합니다. additionalProperties에는 speed나 heading 같은 추가 특성을 지정하며, 해당 통합에 없는 특성은 응답에서 생략합니다. 다음 페이지는 응답의 nextPageToken을 요청 본문의 pageToken에 넣어 조회합니다.

HTTP 요청

POST /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/geotemporalSeries/{property}/loadEntries

작업 식별자는 v2.loadGeotemporalSeriesEntries입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:ontologies-read 권한 범위가 필요합니다. 각 요청에 Authorization: Bearer <접근 토큰>을 전달합니다.

경로 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`ontology`	`string`	필수	온톨로지의 API 이름 또는 RID입니다. List Ontologies 또는 Ontology Manager에서 확인합니다.	`palantir`
`objectType`	`string`	필수	객체 유형의 API 이름입니다. List Object Types 또는 Ontology Manager에서 확인합니다.	`airplane`
`primaryKey`	`string`	필수	지리 시계열 속성을 가진 객체의 기본 키입니다.	`XYZ123`
`property`	`string`	필수	지리 시계열 속성의 API 이름입니다. Ontology Manager 또는 Get Object Type에서 확인합니다.	`locationHistory`

쿼리 매개변수

이름	자료형	필수 여부	의미와 조건	예시 값
`sdkPackageRid`	`string`	선택	생성된 SDK 패키지의 RID입니다.
`sdkVersion`	`string`	선택	생성된 SDK의 버전입니다.
`preview`	`boolean`	선택	`true`이면 미리보기 단계의 베타 기능을 사용합니다.	`true`

요청 본문

본문 형식은 LoadGeotemporalSeriesRequest이며 필수입니다.

객체의 지리 시계열 참조에서 시간 범위 안의 위치 관측값을 불러오는 요청입니다. range와 그 안의 startTime 및 endTime을 지정합니다. additionalProperties로 추가 특성을 선택하고 pageToken으로 다음 페이지를 요청합니다.

이름	자료형	필수 여부	의미와 조건
`range`	`object`	필수	ISO 8601 타임스탬프로 지정한 범위입니다. 시작을 포함하고 끝은 제외합니다.
`additionalProperties`	`list<SelectedPropertyApiName>`	선택	각 항목에 포함할 추가 속성의 API 이름 목록입니다. time과 position은 항상 포함하므로 지정할 필요가 없습니다. speed나 heading 같은 추가 특성을 요청할 수 있으며, 해당 통합에 없는 속성은 응답 항목에서 생략합니다.
`pageToken`	`string`	선택	페이지 조회를 시작할 위치입니다. 첫 요청에서는 생략하고, 다음 요청에서는 직전 응답의 `nextPageToken`을 `pageToken`으로 전달합니다.
`pageSize`	`integer`	선택	요청할 페이지 크기입니다.

`range`의 구조

이름	자료형	필수 여부	의미와 조건	예시 값
`startTime`	`string (date-time)`	필수
`endTime`	`string (date-time)`	필수

`additionalProperties`의 구조

배열 항목은 SelectedPropertyApiName이며 자료형은 string입니다.

시간 범위와 추가 속성을 지정한 요청 본문입니다.

{
  "range": {
    "startTime": "2020-01-01T00:00:00Z",
    "endTime": "2020-06-01T00:00:00Z"
  },
  "additionalProperties": [
    "speed",
    "heading"
  ],
  "pageSize": 100
}

응답

응답 형식은 LoadGeotemporalSeriesResponse입니다.

각 GeotemporalSeriesEntry에는 시간, 위치와 선택한 추가 특성이 들어 있습니다. 아래 응답 예시의 position은 GeoJSON Point 객체로 표현되며 좌표는 경도, 위도 순서입니다.

이름	자료형	필수 여부	의미와 조건	예시 값
`data`	`list<GeotemporalSeriesEntry>`	선택
`nextPageToken`	`string`	선택	다음 페이지를 요청할 때 `pageToken`에 전달할 토큰입니다. 다음 토큰이 없으면 마지막 페이지입니다.

`data`의 구조

배열 항목은 GeotemporalSeriesEntry이며 자료형은 map<PropertyApiName, PropertyValue>입니다.

속성 API 이름과 값으로 구성된 지리 시계열 항목입니다. time(ISO 8601 타임스탬프)과 position(지리적 위치)을 포함하며 speed, heading, altitude 등의 추가 특성을 담을 수 있습니다.

맵의 키는 PropertyApiName(string), 값은 PropertyValue(any)입니다.

키: 속성의 API 이름입니다. Get Object Type 또는 Ontology Manager에서 확인합니다.

추가 속성의 일반 JSON 표현은 객체 속성 값을 참고합니다. 위치 항목은 이 응답의 position 표현을 사용합니다.

위치와 추가 속성을 포함한 응답 예시입니다.

{
  "data": [
    {
      "time": "2020-03-06T12:00:00Z",
      "position": {
        "type": "Point",
        "coordinates": [
          -122.4194,
          37.7749
        ]
      },
      "speed": 120.5,
      "heading": 275.3
    },
    {
      "time": "2020-03-06T13:00:00Z",
      "position": {
        "type": "Point",
        "coordinates": [
          -122.4095,
          37.7845
        ]
      },
      "speed": 95.0,
      "heading": 180.0
    }
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZQ"
}

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/objects/airplane/XYZ123/geotemporalSeries/locationHistory/loadEntries?preview=true" \
	-d '{"range":{"startTime":"2020-01-01T00:00:00Z","endTime":"2020-06-01T00:00:00Z"},"additionalProperties":["speed","heading"],"pageSize":100}'

Python

Requests 라이브러리가 설치된 Python 환경에서 사용합니다.

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "content-type": "application/json",
    "authorization": "Bearer {}".format(TOKEN)
}
request_body = {
    "range": {
        "startTime": "2020-01-01T00:00:00Z",
        "endTime": "2020-06-01T00:00:00Z"
    },
    "additionalProperties": [
        "speed",
        "heading"
    ],
    "pageSize": 100
}

response = requests.post('https://{}/api/v2/ontologies/palantir/objects/airplane/XYZ123/geotemporalSeries/locationHistory/loadEntries?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 LoadGeotemporalSeriesEntriesExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;

public class LoadGeotemporalSeriesEntriesExample {
    public static void main(String[] args) throws Exception {
        String HOSTNAME = System.getenv("FOUNDRY_HOST");
        String TOKEN = System.getenv("FOUNDRY_TOKEN");

        try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
            HttpPost request = new HttpPost("https://" + HOSTNAME + "/api/v2/ontologies/palantir/objects/airplane/XYZ123/geotemporalSeries/locationHistory/loadEntries?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"range\":{\"startTime\":\"2020-01-01T00:00:00Z\",\"endTime\":\"2020-06-01T00:00:00Z\"},\"additionalProperties\":[\"speed\",\"heading\"],\"pageSize\":100}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(response);
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

const HOSTNAME = process.env.FOUNDRY_HOST;
const TOKEN = process.env.FOUNDRY_TOKEN;

fetch(`https://${HOSTNAME}/api/v2/ontologies/palantir/objects/airplane/XYZ123/geotemporalSeries/locationHistory/loadEntries?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"range":{"startTime":"2020-01-01T00:00:00Z","endTime":"2020-06-01T00:00:00Z"},"additionalProperties":["speed","heading"],"pageSize":100}'
}).then((response) => {
    console.log(response)
});

PowerShell

$ErrorActionPreference = 'Stop'
$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

$headers = @{
    "authorization" = "Bearer $TOKEN"
}

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/ontologies/palantir/objects/airplane/XYZ123/geotemporalSeries/locationHistory/loadEntries?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"range`":{`"startTime`":`"2020-01-01T00:00:00Z`",`"endTime`":`"2020-06-01T00:00:00Z`"},`"additionalProperties`":[`"speed`",`"heading`"],`"pageSize`":100}"

$response.content

팔란티어 플랫폼 한국어 해설