템플릿으로 프로젝트 생성(Create Project From Template) (V2)

프로젝트 템플릿의 변수와 생성 규칙을 적용하여 프로젝트를 만듭니다. 템플릿 설정에 따라 새 그룹과 보안 표지가 생성되거나 그룹이 상위 그룹에 추가될 수 있으므로 관련 권한과 이름 충돌도 확인해야 합니다.

템플릿에 정한 조직과 역할 조건을 만족해야 하며 생성 결과에 소유자에 준하는 역할을 가진 주체가 있어야 합니다. 이 기준은 compass:edit-project 작업의 포함 여부입니다. 템플릿의 구성 방법은 프로젝트 템플릿을 참고합니다.

HTTP 요청

POST /api/v2/filesystem/projects/createFromTemplate

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

경로 매개변수

지정할 경로 매개변수가 없습니다.

쿼리 매개변수

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

요청 본문

CreateProjectFromTemplateRequest 본문은 필수입니다. templateRid 외의 입력은 템플릿 설정에 따라 조건이 달라집니다.

고정된 값을 덮어쓰는 요청이나 필요한 값을 빠뜨린 요청은 각각의 검증 오류가 발생합니다. 정의되지 않은 변수 이름도 전달하지 않습니다.

variableValues의 구조

맵의 키는 ProjectTemplateVariableId(string), 값은 ProjectTemplateVariableValue(string)입니다.

키: 프로젝트 템플릿에 정의한 변수의 식별자입니다.

프로젝트 템플릿 변수에 할당할 문자열 값입니다.

defaultRoles의 구조

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

역할의 고유 ID입니다. 역할은 리소스 접근 수준을 정하는 권한 집합입니다. Foundry의 기본 리소스 역할에는 Owner, Editor, Viewer, Discoverer가 있으며, 이 요청에는 대상 리소스에 유효한 실제 역할 ID를 사용합니다.

organizationRids의 구조

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

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

{
  "variableValues": {
    "name": "my project name"
  },
  "organizationRids": [
    "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
  ],
  "defaultRoles": [
    "8bf49052-dc37-4528-8bf0-b551cfb71268"
  ],
  "templateRid": "ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791"
}

응답

응답 형식은 Project입니다.

Project의 12개 필드와 개별 리소스 역할 허용 여부는 Project 자료형을 따릅니다.

가상 템플릿으로 생성한 프로젝트의 응답 예시입니다.

{
  "path": "/Empyrean Airlines/My Important Project",
  "updatedTime": "2024-09-25T17:29:35.974Z",
  "updatedBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
  "displayName": "My Important Project",
  "documentation": "project documentation",
  "resourceLevelRoleGrantsAllowed": true,
  "description": "project description",
  "createdTime": "2024-09-25T17:29:35.974Z",
  "rid": "ri.compass.main.folder.01a79a9d-e293-48db-a585-9ffe221536e8",
  "spaceRid": "ri.compass.main.folder.a86ad5f5-3db5-48e4-9fdd-00aa3e5731ca",
  "trashStatus": "NOT_TRASHED"
}

개별 오류

요청 예제

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

예시는 name 변수가 정의되어 있고 조직과 기본 역할이 제안값이며 설명은 고정된 템플릿을 가정합니다. name은 모든 템플릿에서 예약된 키가 아니라 이 가상 템플릿의 변수 ID입니다. 실제 템플릿의 변수, 선택지와 고정 여부에 맞게 입력을 바꿉니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/filesystem/projects/createFromTemplate" \
	-d '{"variableValues":{"name":"my project name"},"organizationRids":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],"defaultRoles":["8bf49052-dc37-4528-8bf0-b551cfb71268"],"templateRid":"ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791"}'

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 = {
    "variableValues": {
        "name": "my project name"
    },
    "organizationRids": [
        "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
    ],
    "defaultRoles": [
        "8bf49052-dc37-4528-8bf0-b551cfb71268"
    ],
    "templateRid": "ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791"
}

response = requests.post('https://{}/api/v2/filesystem/projects/createFromTemplate'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateProjectFromTemplateExample.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 CreateProjectFromTemplateExample {
    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/createFromTemplate");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"variableValues\":{\"name\":\"my project name\"},\"organizationRids\":[\"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa\"],\"defaultRoles\":[\"8bf49052-dc37-4528-8bf0-b551cfb71268\"],\"templateRid\":\"ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791\"}", 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/createFromTemplate`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"variableValues":{"name":"my project name"},"organizationRids":["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],"defaultRoles":["8bf49052-dc37-4528-8bf0-b551cfb71268"],"templateRid":"ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791"}'
}).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/createFromTemplate" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"variableValues`":{`"name`":`"my project name`"},`"organizationRids`":[`"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa`"],`"defaultRoles`":[`"8bf49052-dc37-4528-8bf0-b551cfb71268`"],`"templateRid`":`"ri.compass.main.template.c410f510-2937-420e-8ea3-8c9bcb3c1791`"}"

$response.content