액션 단건 적용(Apply Action) (V1)

액션 유형에 매개변수를 전달하여 객체와 링크에 변경을 적용합니다.

Object Storage V1의 변경은 최종 일관성으로 반영되어 보이기까지 시간이 걸릴 수 있습니다. Object Storage V2의 변경은 액션이 완료된 직후 보입니다. 이 엔드포인트는 구성된 매개변수 기본값을 지원하지 않으므로 필요한 값을 요청에 명시합니다.

쿼리 매개변수는 없습니다. ApplyActionRequest JSON 본문은 필수이며, parameters의 필요한 항목과 값 형식은 액션 정의를 따릅니다. 온톨로지 RID는 List Ontologies나 Ontology Manager에서, 액션 API 이름은 List Action Types나 Ontology Manager에서 확인합니다. 값의 인코딩은 DataValue를 따릅니다.

예시 액션은 id와 newName을 받아 가상 직원의 이름을 변경하도록 구성되어 있습니다. 성공 응답 모델 ApplyActionResponse에는 추가 필드가 없습니다.

HTTP 요청

POST /api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply

작업 식별자는 v1.applyAction입니다. Authorization: Bearer <접근 토큰> 헤더로 인증합니다. OAuth 클라이언트에는 api:ontologies-read, api:ontologies-write 권한 범위가 필요합니다.

JSON 요청 예시

가상 액션에 전달하는 요청 예시입니다.

{
  "parameters": {
    "id": 80060,
    "newName": "Anna Smith-Doe"
  }
}

JSON 응답 예시

가상 온톨로지의 응답 예시입니다.

{}

오류

실패 응답은 공통 API 오류의 형식으로 처리합니다.

요청 예제

FOUNDRY_HOST에는 https://를 제외한 Foundry 호스트를, FOUNDRY_TOKEN에는 유효한 토큰을 환경 변수로 제공합니다. 아래 식별자와 입력값은 예시이므로 실제 요청 대상에 맞게 지정합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/apply" \
	-d '{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}'

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 = {
    "parameters": {
        "id": 80060,
        "newName": "Anna Smith-Doe"
    }
}

response = requests.post('https://{}/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/apply'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용하는 예제입니다. 클래스 이름에 맞는 ApplyActionExample.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 ApplyActionExample {
    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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/apply");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"parameters\":{\"id\":80060,\"newName\":\"Anna Smith-Doe\"}}", 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/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/apply`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"parameters":{"id":80060,"newName":"Anna Smith-Doe"}}'
}).then((response) => {
    console.log(response)
});

PowerShell

$TOKEN = $env:FOUNDRY_TOKEN
$HOSTNAME = $env:FOUNDRY_HOST

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

$response = Invoke-WebRequest -Uri "https://$HOSTNAME/api/v1/ontologies/ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367/actions/rename-employee/apply" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"parameters`":{`"id`":80060,`"newName`":`"Anna Smith-Doe`"}}"

$response.content