Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

리소스에 보안 표지 추가(Add Markings) (V2)

리소스에 보안 표지 ID 목록을 추가합니다. 표지는 해당 리소스의 접근 요구조건에 영향을 주므로 적용 대상과 표지를 확인하여 요청합니다.

조직 표지는 일반 보안 표지로 추가할 수 없습니다. 조직 요구조건은 프로젝트의 조직 관리 엔드포인트로 다룹니다. 숨김 리소스와 자동 저장 리소스도 이 작업을 지원하지 않습니다.

HTTP 요청

POST /api/v2/filesystem/resources/{resourceRid}/addMarkings

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
resourceRidstring필수리소스의 고유 식별자(RID)입니다.ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da

쿼리 매개변수

지정할 쿼리 매개변수가 없습니다.

요청 본문

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

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

markingIds의 구조

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

보안 표지의 ID입니다.

다음 본문의 식별자와 값은 가상 예시입니다.

{
  "markingIds": [
    "18212f9a-0e63-4b79-96a0-aae04df23336"
  ]
}

응답

성공 응답에 반환할 본문 모델이 없습니다.

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
OrganizationMarkingNotSupportedINVALID_ARGUMENT400조직 표지를 일반 보안 표지처럼 관리할 수 없습니다. 프로젝트의 조직 관리 엔드포인트를 사용합니다.markingIds
ForbiddenOperationOnHiddenResourceINVALID_ARGUMENT400숨김 리소스에서는 이 작업을 지원하지 않습니다.resourceRid
ForbiddenOperationOnAutosavedResourceINVALID_ARGUMENT400자동 저장 리소스에서는 이 작업을 지원하지 않습니다.resourceRid
MarkingNotFoundNOT_FOUND404지정한 보안 표지 ID를 찾을 수 없습니다.markingIds
AddMarkingsPermissionDeniedPERMISSION_DENIED403리소스에 보안 표지를 추가할 수 없습니다.resourceRid
ResourceNotFoundNOT_FOUND404지정한 리소스를 찾을 수 없습니다.resourceRid

요청 예제

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

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/addMarkings" \
	-d '{"markingIds":["18212f9a-0e63-4b79-96a0-aae04df23336"]}'

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 = {
    "markingIds": [
        "18212f9a-0e63-4b79-96a0-aae04df23336"
    ]
}

response = requests.post('https://{}/api/v2/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/addMarkings'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddMarkingsExample.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 AddMarkingsExample {
    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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/addMarkings");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"markingIds\":[\"18212f9a-0e63-4b79-96a0-aae04df23336\"]}", 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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/addMarkings`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"markingIds":["18212f9a-0e63-4b79-96a0-aae04df23336"]}'
}).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/filesystem/resources/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/addMarkings" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"markingIds`":[`"18212f9a-0e63-4b79-96a0-aae04df23336`"]}"

$response.content