일반 지도 심볼 PNG 조회(Generic Symbol) (V2)

불투명한 심볼 ID로 PNG 아이콘을 가져옵니다. 정수 매개변수 size로 아이콘 크기를 지정합니다.

보관한 ETag가 있으면 If-None-Match 헤더로 조건부 조회할 수 있습니다. 아이콘이 바뀌지 않았으면 304를 반환하므로 새 PNG 본문을 저장하지 않고 기존 캐시를 사용합니다. 응답은 Cache-Control과 Content-Type 헤더를 제공합니다.

Authorization 헤더가 없으면 기존 PALANTIR_TOKEN 쿠키를 사용합니다. 아래의 명시적인 Bearer 토큰 예제와 브라우저의 쿠키 인증 경로를 구분합니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

GET /api/v2/mapRendering/symbols/{symbolId}/generic

작업 식별자는 v2.genericSymbol입니다. OAuth2로 호출하는 타사 애플리케이션에는 api:map-read 권한 범위가 필요합니다. Bearer 토큰으로 인증할 때는 Authorization: Bearer <접근 토큰>을 전달합니다. 이 헤더가 없으면 PALANTIR_TOKEN 쿠키로 인증합니다.

경로 매개변수

쿼리 매개변수

요청 본문

요청 본문을 사용하지 않습니다.

응답

일반 응답 본문은 PNG 이미지의 바이너리입니다. 조건부 요청의 304는 새 이미지 본문을 반환하는 응답과 구분합니다.

개별 오류

요청 예제

SYMBOL_PATH_ID에는 실제 심볼 ID를 URL 경로 구성요소로 한 번 인코딩한 값을 제공합니다. size=1은 크기 매개변수의 예시 정수입니다. 필요한 값으로 바꾸되 다른 스타일 필드의 기본값이나 단위를 이 매개변수에 그대로 적용하지 않습니다. 이 예제는 If-None-Match를 보내지 않는 일반 PNG 다운로드입니다.

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 제공합니다.

SYMBOL_OUTPUT_FILE은 저장할 로컬 파일 경로입니다. 기존 파일을 덮어쓰며 본문을 텍스트로 변환하지 않고 바이트로 기록합니다.

cURL

curl --fail --output "${SYMBOL_OUTPUT_FILE}" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/mapRendering/symbols/${SYMBOL_PATH_ID}/generic?size=1&preview=true"

Python

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

import os
import requests

HOSTNAME = os.environ["FOUNDRY_HOST"]
TOKEN = os.environ["FOUNDRY_TOKEN"]
headers = {
    "authorization": "Bearer {}".format(TOKEN)
}

with requests.get('https://{}/api/v2/mapRendering/symbols/{symbol_id}/generic?size=1&preview=true'.format(HOSTNAME, symbol_id=os.environ["SYMBOL_PATH_ID"]), headers=headers, stream=True) as response:
    response.raise_for_status()
    with open(os.environ["SYMBOL_OUTPUT_FILE"], "wb") as output:
        for chunk in response.iter_content(chunk_size=1024 * 1024):
            output.write(chunk)

Java

Apache HttpClient 4.5 API를 사용하는 GenericSymbolExample.java 예제입니다.

import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

public class GenericSymbolExample {
    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()) {
            HttpGet request = new HttpGet("https://" + HOSTNAME + "/api/v2/mapRendering/symbols/" + System.getenv("SYMBOL_PATH_ID") + "/generic?size=1&preview=true");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                int status = response.getStatusLine().getStatusCode();
                if (status < 200 || status >= 300) throw new IOException("HTTP " + status);
                try (OutputStream output = Files.newOutputStream(Paths.get(System.getenv("SYMBOL_OUTPUT_FILE")))) {
                    response.getEntity().writeTo(output);
                }
            }
        }
    }
}

JavaScript

fetch를 제공하는 Node.js 환경에서 사용합니다. import가 있는 예제는 ES 모듈(.mjs)로 실행합니다. 서비스 사용자 토큰을 브라우저로 전달하지 않습니다.

import { createWriteStream } from "node:fs";
import { Readable } from "node:stream";
import { pipeline } from "node:stream/promises";

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

const response = await fetch(`https://${HOSTNAME}/api/v2/mapRendering/symbols/${process.env.SYMBOL_PATH_ID}/generic?size=1&preview=true`, {
    method: 'GET',
    headers: {
        'Authorization': `Bearer ${TOKEN}`,
    }
 });
if (!response.ok) {
    await response.body?.cancel();
    throw new Error(`HTTP ${response.status}`);
}
await pipeline(Readable.fromWeb(response.body), createWriteStream(process.env.SYMBOL_OUTPUT_FILE));

PowerShell

스크립트 오류가 발생하면 중단하도록 ErrorActionPreference를 설정합니다.

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

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

Invoke-WebRequest -Uri "https://$HOSTNAME/api/v2/mapRendering/symbols/${env:SYMBOL_PATH_ID}/generic?size=1&preview=true" `
	-Headers $headers `
    -OutFile $env:SYMBOL_OUTPUT_FILE