Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

같은 유형의 액션 일괄 적용(Apply Action Batch) (V2)

같은 액션 유형을 서로 다른 매개변수로 여러 번 적용합니다. 한 번에 최대 20건을 적용할 수 있습니다. Object Storage V2의 객체만 변경하고 Functions를 호출하지 않는 액션에는 더 높은 한도가 적용될 수 있습니다.

이 엔드포인트는 알림을 지원하지 않습니다. Object Storage V1의 객체와 링크 변경은 최종 일관성을 따르며, Object Storage V2의 변경은 액션이 끝난 직후 보입니다. 예시는 두 직원의 이름을 변경하는 요청입니다.

HTTP 요청

POST /api/v2/ontologies/{ontology}/actions/{action}/applyBatch

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
ontologystring필수온톨로지의 API 이름 또는 RID입니다. List Ontologies 또는 Ontology Manager에서 확인합니다.palantir
actionstring필수적용할 액션의 API 이름입니다. List Action Types 또는 Ontology Manager에서 확인합니다.rename-employee

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
sdkPackageRidstring선택생성된 SDK 패키지의 RID입니다.
sdkVersionstring선택생성된 SDK의 버전입니다.
scenarioRidstring선택액션들을 적용할 온톨로지 시나리오의 RID입니다.ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890
branchstring선택액션을 적용할 Foundry 브랜치입니다. 생략하면 기본 브랜치를 사용합니다. 브랜치는 실험적 기능이며 모든 작업 경로를 지원하지 않습니다.ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252

요청 본문

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

이름자료형필수 여부의미와 조건예시 값
optionsobject선택
requestslist<BatchApplyActionRequestItem>선택

options의 구조

이름자료형필수 여부의미와 조건예시 값
returnEditsenum선택생략하면 NONE입니다. 허용값: ALL, NONE.

requests의 구조

배열 항목은 BatchApplyActionRequestItem이며 자료형은 object입니다.

이름자료형필수 여부의미와 조건예시 값
parametersmap<ParameterId, DataValue>선택
parameters의 구조

맵의 키는 ParameterId(string), 값은 DataValue(any)입니다.

키: 액션이나 쿼리 입력에 사용하는 매개변수의 고유 ID입니다. 매개변수는 Ontology Manager에서 확인하고 관리할 수 있습니다.

중첩 가능한 데이터 값입니다. 자료형별 JSON 표현은 액션 데이터 값을 따릅니다.

직원 두 명의 이름을 변경하는 요청 본문 예시입니다.

{
  "requests": [
    {
      "parameters": {
        "id": 80060,
        "newName": "Anna Smith-Doe"
      }
    },
    {
      "parameters": {
        "id": 80061,
        "newName": "Joe Bloggs"
      }
    }
  ]
}

응답

응답 형식은 BatchApplyActionResponseV2입니다.

성공 응답입니다.

이름자료형필수 여부의미와 조건예시 값
editsunion<edits, largeScaleEdits>선택

edits의 구조

해당 요청 방식의 편집 응답을 따릅니다.

편집 반환을 요청하지 않은 일괄 액션의 응답 예시입니다.

{}

개별 오류

오류 응답 처리는 공통 API 오류 계약을 따릅니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 예시 식별자와 매개변수 값은 실제 작업 대상에 맞게 바꿉니다.

시나리오 RID와 브랜치 RID, 액션 이름 및 입력값은 실제 변경 대상에 맞춰 지정합니다. 기본 브랜치를 사용할 때는 branch를 생략합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/ontologies/palantir/actions/rename-employee/applyBatch?scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890&branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" \
	-d '{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}'

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 = {
    "requests": [
        {
            "parameters": {
                "id": 80060,
                "newName": "Anna Smith-Doe"
            }
        },
        {
            "parameters": {
                "id": 80061,
                "newName": "Joe Bloggs"
            }
        }
    ]
}

response = requests.post('https://{}/api/v2/ontologies/palantir/actions/rename-employee/applyBatch?scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890&branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252'.format(HOSTNAME), headers=headers, json=request_body)
response.raise_for_status()
print(response.json())

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 ApplyActionBatchV2Example.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 ApplyActionBatchV2Example {
    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/actions/rename-employee/applyBatch?scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890&branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"requests\":[{\"parameters\":{\"id\":80060,\"newName\":\"Anna Smith-Doe\"}},{\"parameters\":{\"id\":80061,\"newName\":\"Joe Bloggs\"}}]}", ContentType.APPLICATION_JSON));
            try (CloseableHttpResponse response = httpClient.execute(request)) {
                System.out.println(org.apache.http.util.EntityUtils.toString(response.getEntity(), java.nio.charset.StandardCharsets.UTF_8));
            }
        }
    }
}

JavaScript

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

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

fetch(`https://${HOSTNAME}/api/v2/ontologies/palantir/actions/rename-employee/applyBatch?scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890&branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"requests":[{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}},{"parameters":{"id":80061,"newName":"Joe Bloggs"}}]}'
}).then(async (response) => {
    console.log(await response.json());
});

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/actions/rename-employee/applyBatch?scenarioRid=ri.actions..scenario.a1b2c3d4-e5f6-7890-abcd-ef1234567890&branch=ri.branch..branch.d827184f-ee0e-4351-8b70-efbe51e07252" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"requests`":[{`"parameters`":{`"id`":80060,`"newName`":`"Anna Smith-Doe`"}},{`"parameters`":{`"id`":80061,`"newName`":`"Joe Bloggs`"}}]}"

$response.content