Workbench 보드에 객체 추가(Add Board Objects) (V2)

Foundry 객체를 워크벤치 보드에 연결하여 보드의 작업 흐름 안에서 객체를 추적할 수 있게 합니다. stateId를 생략하면 보드에서 설정한 순서의 첫 상태에 배치합니다. 기본 상태가 없는 보드에서는 상태를 직접 지정해야 합니다.

이미 보드에 있는 객체를 다시 추가하면 ObjectAlreadyOnBoard 오류가 발생합니다. 기존 항목의 상태를 바꾸려면 객체 이동을 사용합니다. 보드가 요구하는 객체 유형 또는 인터페이스, 보안 요건과 항목 수 제한도 충족해야 합니다.

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

HTTP 요청

PUT /api/v2/workbench/boards/{boardRid}/objects/add

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

경로 매개변수

쿼리 매개변수

요청 본문

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

objectRids의 구조

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

Foundry 객체의 고유 식별자입니다.

다음은 객체와 배치할 상태를 지정하는 요청 본문 예시입니다.

{
  "objectRids": [
    "ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"
  ],
  "stateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

응답

응답 형식은 EmptySuccessResponse입니다.

요청이 성공했음을 나타내는 빈 응답 객체입니다.

개별 오류

요청 예제

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

예제의 보드, 객체와 상태 식별자를 실제 작업 대상에 맞게 바꾸면 객체가 해당 보드에 추가됩니다. 기본 상태에 배치하려면 본문의 stateId를 생략합니다.

cURL

curl -X PUT \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer ${FOUNDRY_TOKEN}" \
	"https://${FOUNDRY_HOST}/api/v2/workbench/boards/ri.gotham-artifact.0-0.workbench-board.example/objects/add?preview=true" \
	-d '{"objectRids":["ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"],"stateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

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 = {
    "objectRids": [
        "ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"
    ],
    "stateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

response = requests.put('https://{}/api/v2/workbench/boards/ri.gotham-artifact.0-0.workbench-board.example/objects/add?preview=true'.format(HOSTNAME), headers=headers, json=request_body)
print(response)

Java

Apache HttpClient 4.5 API와 try-with-resources를 사용합니다. 클래스 이름에 맞는 AddBoardObjectsExample.java 파일에서 사용합니다.

import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPut;
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 AddBoardObjectsExample {
    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()) {
            HttpPut request = new HttpPut("https://" + HOSTNAME + "/api/v2/workbench/boards/ri.gotham-artifact.0-0.workbench-board.example/objects/add?preview=true");
            request.addHeader("content-type", "application/json");
            request.addHeader("authorization", String.format("Bearer %s", TOKEN));
            request.setEntity(new StringEntity("{\"objectRids\":[\"ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5\"],\"stateId\":\"3fa85f64-5717-4562-b3fc-2c963f66afa6\"}", 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/workbench/boards/ri.gotham-artifact.0-0.workbench-board.example/objects/add?preview=true`, {
    method: 'PUT',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${TOKEN}`,
    },
    body: '{"objectRids":["ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5"],"stateId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'
}).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/workbench/boards/ri.gotham-artifact.0-0.workbench-board.example/objects/add?preview=true" `
	-Method Put `
	-Headers $headers `
	-ContentType application/json `
	-Body "{`"objectRids`":[`"ri.phonograph2-objects.main.object.48668bf6-8878-48d2-b8f8-f0017593feb5`"],`"stateId`":`"3fa85f64-5717-4562-b3fc-2c963f66afa6`"}"

$response.content