파라메트릭 컴포넌트 등록하기

파라미터로 치수·색상 등을 동적으로 조합할 수 있는 파라메트릭 컴포넌트를 생성하고 관리하는 방법을 안내합니다.

파라메트릭 컴포넌트는 치수, 색상 등의 파라미터를 동적으로 조합할 수 있는 고급 컴포넌트입니다. 일반 컴포넌트와 달리 사용자가 아키스케치 에디터에서 파라미터 값을 직접 조정할 수 있습니다.

모든 API 요청 헤더에 X-API-KEY를 포함해야 합니다. 발급 방법은 API 사용 방법을 참고하세요.

X-API-KEY: {x-api-key}

파라메트릭 컴포넌트 생성하기

POST /api/v1/parametric

1

필요한 정보 준비하기

파라메트릭 컴포넌트는 일반 컴포넌트 정보 외에 파라미터 목록과 컴포지션 목록이 필요합니다.

필드	타입	필수	설명
name	string	✅	이름
parametricType	string	✅	파라메트릭 유형 (assembly, parametric-modeling)
translatedNames	array	✅	다국어 이름
dimension	object	✅	치수
parameters	array	✅	파라미터 목록
compositions	array	✅	컴포지션 목록
images	array	✅	이미지 URL 목록
isFinal	boolean		최종 부품 여부 (에디터에서 직접 배치 가능 여부)
isPersonal	boolean		개인 라이브러리 여부
modelingId	string		모델링 ID
parametricModeling	object		파라메트릭 모델링 (parametric-modeling 타입일 때 사용)
editorSetting	object		에디터 설정
extra	object		추가 정보 (boundingBox 등)
previewImage	string		미리보기 이미지 URL
code	string		코드
brandCode	string		브랜드 코드
sku	string		SKU
color	object		색상
retailPrice	object		소비자가
factoryPrice	object		공장가
mainMaterial	string		주재료
glbUrl	string		GLB URL
category	object		카테고리

2

요청 보내기

POST /api/v1/parametric
X-API-KEY: {x-api-key}

{
  "name": "파라메트릭 소파",
  "parametricType": "assembly",
  "translatedNames": [
    { "code": "en", "value": "Parametric Sofa" },
    { "code": "ko", "value": "파라메트릭 소파" }
  ],
  "dimension": {
    "mm": { "width": 0, "depth": 0, "height": 0 }
  },
  "images": [],
  "isFinal": true,
  "editorSetting": {
    "editorType": "STANDING_ITEM",
    "dimensionLock": { "width": false, "depth": false, "height": false }
  },
  "parameters": [
    {
      "displayName": "Width",
      "referenceName": "W",
      "type": "BASIC",
      "valueInfo": {
        "usage": "NUMBER",
        "value": "900",
        "optionType": "RANGE",
        "options": { "min": "100", "max": "2400", "stepSize": "1" }
      },
      "priority": 0
    }
  ],
  "compositions": [],
  "parametricModeling": null
}

3

응답 확인하기

생성된 파라메트릭 컴포넌트의 ID를 저장해두세요. 이후 파라미터 추가·수정에 사용합니다.

{
  "result": "SUCCESS",
  "data": {
    "componentId": "pmc_abc123"
  }
}

파라메트릭 컴포넌트 수정하기

PUT /api/v1/parametric/components/{id}

생성과 동일한 Request Body 구조입니다.

파라미터	타입	필수	설명
id	string	✅	컴포넌트 ID

파라미터 관리하기

파라미터 목록 조회

GET /api/v1/parametric/components/{componentId}/parameters

GET /api/v1/parametric/components/pmc_abc123/parameters
X-API-KEY: {x-api-key}

파라미터 추가

POST /api/v1/parametric/components/{componentId}/parameters

필드	타입	필수	설명
parameters	array	✅	생성할 파라미터 목록

파라미터 수정

POST /api/v1/parametric/components/parameters/{parameterId}

필드	타입	필수	설명
displayName	string	✅	표시 이름
referenceName	string	✅	참조 이름
type	string	✅	파라미터 타입
valueInfo	object	✅	값 정보
priority	integer	✅	우선순위
description	string		설명
hideCondition	string		숨김 조건 표현식
enterpriseParameterId	string		기업 파라미터 ID

파라미터 단건 삭제

DELETE /api/v1/parametric/components/parameters/{parameterId}

파라미터 다건 삭제

DELETE /api/v1/parametric/components/parameters

필드	타입	필수	설명
parameterIds	array	✅	삭제할 파라미터 ID 목록