Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

프로젝트 리소스 참조 제거(Remove Project Resource References) (V2)

프로젝트에서 지정한 리소스의 참조를 제거합니다. resources에는 파일시스템 또는 외부 리소스의 RID 문자열을 넣습니다. 추가 요청과 달리 구분자 객체나 importName을 사용하지 않습니다.

원본 리소스의 휴지통 이동과는 다른 작업입니다. 참조를 사용하는 프로젝트 작업이 있는지 확인한 뒤 제거합니다.

HTTP 요청

POST /api/v2/filesystem/projects/{projectRid}/references/remove

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

경로 매개변수

이름자료형필수 여부의미와 조건예시 값
projectRidstring필수프로젝트의 고유 식별자(RID)입니다.ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8

쿼리 매개변수

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

요청 본문

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

이름자료형필수 여부의미와 조건예시 값
resourceslist<rid>선택프로젝트 참조에서 제거할 리소스 RID 목록입니다. 파일시스템 리소스와 그 밖의 외부 리소스 RID를 모두 사용할 수 있습니다.본문 예시 참조

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

{
  "resources": [
    "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
  ]
}

응답

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

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
InvalidResourceReferenceINVALID_ARGUMENT400리소스 참조가 유효하지 않습니다. RID 형식이 잘못되었거나 리소스 유형과 참조 유형이 맞지 않거나 참조로 사용할 수 없는 리소스인 경우에 발생합니다.resourceRid
InvalidProjectINVALID_ARGUMENT400지정한 RID가 유효한 프로젝트를 가리키지 않습니다.projectRid
RemoveProjectResourceReferencesPermissionDeniedPERMISSION_DENIED403프로젝트에서 리소스 참조를 제거할 수 없습니다.projectRid
ProjectNotFoundNOT_FOUND404지정한 프로젝트를 찾을 수 없습니다.projectRid
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/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/remove" \
	-d '{"resources":["ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"]}'

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 = {
    "resources": [
        "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
    ]
}

response = requests.post('https://{}/api/v2/filesystem/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/remove'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 RemoveProjectResourceReferencesExample.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 RemoveProjectResourceReferencesExample {
    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/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/remove");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"resources\":[\"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da\"]}", 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/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/remove`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"resources":["ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"]}'
}).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/projects/ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8/references/remove" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"resources`":[`"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`"]}"

$response.content