Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

Model Studio 생성(Create Model Studio) (V2)

이름과 상위 폴더를 지정하여 새 Model Studio 리소스를 만듭니다. name과 parentFolderRid는 모두 필수입니다.

이름은 700자 이하여야 하고 정확히 . 또는 ..일 수 없으며 /를 포함할 수 없습니다. 같은 폴더의 이름과 충돌하면 오류가 발생합니다.

이 엔드포인트는 미리보기 기능이며 언제든 변경되거나 제거될 수 있습니다. 사용하려면 preview=true를 지정합니다.

HTTP 요청

POST /api/v2/models/modelStudios

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

경로 매개변수

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

쿼리 매개변수

이름자료형필수 여부의미와 조건예시 값
previewboolean선택미리보기 기능 사용을 활성화합니다.true

요청 본문

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

이름자료형필수 여부의미와 조건예시 값
namestring필수Model Studio의 이름입니다.
parentFolderRidstring필수Model Studio를 만들 상위 폴더의 RID입니다.ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791

요청 본문 예시입니다.

{
  "parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
  "name": "House Price Training Studio"
}

응답

응답 형식은 ModelStudio입니다.

반환된 Model Studio입니다.

이름자료형필수 여부의미와 조건예시 값
ridstring필수Model Studio의 RID입니다.ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890
folderRidstring필수Model Studio가 있는 상위 폴더입니다.ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791
createdTimestring (date-time)필수리소스 생성 시각입니다.2003-05-06T12:34:56.789Z

새 Model Studio의 응답 예시입니다.

{
  "createdTime": "2003-05-06T12:34:56.789Z",
  "rid": "ri.models.main.model-studio.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "folderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791"
}

개별 오류

오류 이름오류 코드HTTP의미와 조건추가 매개변수
ResourceNameAlreadyExistsCONFLICT409같은 폴더 안의 다른 리소스가 이미 사용하는 이름입니다.parentFolderRid, displayName
InvalidDisplayNameINVALID_ARGUMENT400표시 이름은 . 또는 .. 자체일 수 없고 /를 포함할 수 없으며 길이는 700자 이하여야 합니다.displayName
InvalidModelStudioCreateRequestINVALID_ARGUMENT400Model Studio 생성 요청의 인수가 유효하지 않습니다.
CreateModelStudioPermissionDeniedPERMISSION_DENIED403Model Studio를 생성할 권한이 없습니다.

요청 예제

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

지정한 폴더에 House Price Training Studio를 만드는 예제입니다. 실제 폴더와 사용할 이름을 지정합니다.

cURL

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/models/modelStudios?preview=true" \
	-d '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"House Price Training Studio"}'

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 = {'parentFolderRid': 'ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791',
 'name': 'House Price Training Studio'}

response = requests.post('https://{}/api/v2/models/modelStudios?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 CreateModelStudioExample.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 CreateModelStudioExample {
    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/models/modelStudios?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"parentFolderRid\":\"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791\",\"name\":\"House Price Training Studio\"}", 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/models/modelStudios?preview=true`, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"parentFolderRid":"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791","name":"House Price Training Studio"}'
}).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/models/modelStudios?preview=true" `
	-Method Post `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"parentFolderRid`":`"ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791`",`"name`":`"House Price Training Studio`"}"

$response.content