이 페이지에서
> 리소스 > 문서 > api > API 레퍼런스: 프로세스

API 레퍼런스: 프로세스

이 엔드포인트는 사용자의 워크스페이스에서 작동합니다. 무료 체험을 시작해 워크스페이스를 만들고 첫 API를 호출하세요.

프로세스 목록 조회

엔드포인트: GET /v1/tenant/{tenantId}/processes

인증: 테넌트 범위 API 키 · read scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
limit integer 쿼리 아니요 반환할 최대 항목 수
offset integer 쿼리 아니요 건너뛸 항목 수

응답(200):

프로세스 목록

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"treeParentId": "00000000-0000-0000-0000-000000000000",
		"treeNodeType": "Process",
		"displayName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"designerModelId": "00000000-0000-0000-0000-000000000000"
	}
]

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨

프로세스 생성(빈 모델)

엔드포인트: POST /v1/tenant/{tenantId}/processes

인증: 테넌트 범위 API 키 · write scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid

요청 본문:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process"
}
필드 유형 필수 설명
displayName string 예 프로세스 트리에 표시되는 프로세스 이름
최대 길이: 128
treeParentId string 아니요 상위 폴더 ID (null = 최상위 수준)
형식: uuid
treeNodeType Process | TreeGroup 아니요 프로세스 또는 TreeGroup(폴더)
허용 값: Process, TreeGroup
기본값: Process

응답(201):

프로세스 생성됨

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
id string 예 형식: uuid
treeParentId string 예 형식: uuid
treeNodeType Process | TreeGroup 예 허용 값: Process, TreeGroup
기본값: Process
displayName string 예 기본값: New Process
최대 길이: 128
createdAt string 예 형식: date-time
updatedAt string 예 형식: date-time
designerModelId string 예 형식: uuid

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
  • 500 예기치 않은 서버 오류: 요청을 안전하게 다시 시도할 수 있음

프로세스 조회

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}

인증: 테넌트 범위 API 키 · read scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

응답(200):

프로세스

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
id string 예 형식: uuid
treeParentId string 예 형식: uuid
treeNodeType Process | TreeGroup 예 허용 값: Process, TreeGroup
기본값: Process
displayName string 예 기본값: New Process
최대 길이: 128
createdAt string 예 형식: date-time
updatedAt string 예 형식: date-time
designerModelId string 예 형식: uuid

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
  • 404 리소스를 찾을 수 없음

프로세스 수정

엔드포인트: PUT /v1/tenant/{tenantId}/processes/{processId}

인증: 테넌트 범위 API 키 · write scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

요청 본문:

{
	"displayName": "string",
	"treeParentId": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
displayName string 아니요 프로세스 트리에 표시되는 프로세스 이름
최대 길이: 128
treeParentId string 아니요 상위 폴더 ID(null = 최상위)
형식: uuid

응답(200):

프로세스 수정됨

{
	"id": "00000000-0000-0000-0000-000000000000",
	"treeParentId": "00000000-0000-0000-0000-000000000000",
	"treeNodeType": "Process",
	"displayName": "string",
	"createdAt": "2024-03-15T16:30:00Z",
	"updatedAt": "2024-03-15T16:30:00Z",
	"designerModelId": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
id string 예 형식: uuid
treeParentId string 예 형식: uuid
treeNodeType Process | TreeGroup 예 허용 값: Process, TreeGroup
기본값: Process
displayName string 예 기본값: New Process
최대 길이: 128
createdAt string 예 형식: date-time
updatedAt string 예 형식: date-time
designerModelId string 예 형식: uuid

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
  • 404 리소스를 찾을 수 없음
  • 500 예기치 않은 서버 오류: 요청을 안전하게 다시 시도할 수 있음

프로세스 소프트 삭제

엔드포인트: DELETE /v1/tenant/{tenantId}/processes/{processId}

인증: 테넌트 범위 API 키 · write scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

응답(200):

프로세스 삭제됨

{
	"success": true,
	"message": "string"
}
필드 유형 필수 설명
success boolean 예
message string 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
  • 404 리소스를 찾을 수 없음

프로세스 모델을 BPMN 2.0 XML로 내보내기

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/bpmn

인증: 테넌트 범위 API 키 · read scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

응답(200):

BPMN XML

{
	"bpmnXml": "string"
}
필드 유형 필수 설명
bpmnXml string 예 BPMN 2.0 XML

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
  • 403 API 키에 필요한 scope 또는 조직 액세스 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않음
  • 404 리소스를 찾을 수 없음
  • 500 예기치 않은 서버 오류: 요청을 안전하게 다시 시도할 수 있음

프로세스에 BPMN 2.0 모델 가져오기(현재 모델 대체)

엔드포인트: PUT /v1/tenant/{tenantId}/processes/{processId}/bpmn

인증: 테넌트 범위 API 키 · write scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

요청 본문:

{
	"bpmnXml": "string"
}
필드 유형 필수 설명
bpmnXml string 예 BPMN 2.0 XML

응답(200):

BPMN 업로드됨

{
	"message": "string"
}
필드 유형 필수 설명
message string 예

오류:

  • 400 잘못된 요청: 유효하지 않은 필터 표현식, 모델이 없는 프로세스, 지원되지 않는 업로드 형식 또는 필수 필드 누락 등
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료됨
  • 404 리소스를 찾을 수 없음

데이터 매핑은 데이터 테이블을 프로세스에 연결합니다. 이를 통해 프로세스 모델에서 이벤트 로그 데이터를 시각화하고 분석할 수 있습니다.

프로세스의 데이터 매핑 목록 조회

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/mappings

인증: 테넌트 범위 API 키 · read scope

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
limit integer 쿼리 아니요 반환할 최대 항목 수
offset integer 쿼리 아니요 건너뛸 항목 수

응답(200):

매핑 목록

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"dataTableId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"color": {
			"id": "data-1"
		},
		"showByDefault": true,
		"mappingRole": "primary",
		"sortOrder": 0
	}
]

오류:

  • 400 잘못된 요청: 필터 표현식이 유효하지 않거나, 모델이 없는 프로세스이거나, 지원하지 않는 파일 형식이거나, 필수 필드가 누락된 경우
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

데이터 테이블을 프로세스에 매핑합니다(이벤트 로그 처리 시작)

엔드포인트: POST /v1/tenant/{tenantId}/processes/{processId}/mappings

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

요청 본문:

{
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary"
}
필드 유형 필수 설명
dataTableId string 예 프로세스에 매핑할 데이터 테이블
형식: uuid
displayName string 아니요 매핑에 표시할 이름
최대 길이: 128
color object 아니요 강조 색상
showByDefault boolean 아니요 프로세스 보기에서 이 매핑을 기본으로 표시할지 여부
기본값: true
mappingRole primary | comparison 아니요 모델에서 매핑된 데이터의 역할
허용 값: primary, comparison

응답(201):

매핑을 생성했습니다

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
필드 유형 필수 설명
id string 예 형식: uuid
modelId string 예 형식: uuid
dataTableId string 예 형식: uuid
displayName string 예 최대 길이: 128
color object 예
showByDefault boolean 예 기본값: true
mappingRole primary | comparison 예 허용 값: primary, comparison
기본값: comparison
sortOrder integer 예 기본값: 0
최솟값: -9007199254740991
최댓값: 9007199254740991

오류:

  • 400 잘못된 요청: 필터 표현식이 유효하지 않거나, 모델이 없는 프로세스이거나, 지원하지 않는 파일 형식이거나, 필수 필드가 누락된 경우
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 403 API 키에 필요한 범위 또는 조직 접근 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않는 경우
  • 404 리소스를 찾을 수 없음

매핑 업데이트

엔드포인트: PUT /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
mappingId string 경로 예 형식: uuid

요청 본문:

{
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
필드 유형 필수 설명
displayName string 아니요 최대 길이: 128
color object 아니요
showByDefault boolean 아니요
mappingRole primary | comparison 아니요 허용 값: primary, comparison
sortOrder integer 아니요 최솟값: -9007199254740991
최댓값: 9007199254740991

응답(200):

매핑을 업데이트했습니다

{
	"id": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"color": {
		"id": "data-1"
	},
	"showByDefault": true,
	"mappingRole": "primary",
	"sortOrder": 0
}
필드 유형 필수 설명
id string 예 형식: uuid
modelId string 예 형식: uuid
dataTableId string 예 형식: uuid
displayName string 예 최대 길이: 128
color object 예
showByDefault boolean 예 기본값: true
mappingRole primary | comparison 예 허용 값: primary, comparison
기본값: comparison
sortOrder integer 예 기본값: 0
최솟값: -9007199254740991
최댓값: 9007199254740991

오류:

  • 400 잘못된 요청: 필터 표현식이 유효하지 않거나, 모델이 없는 프로세스이거나, 지원하지 않는 파일 형식이거나, 필수 필드가 누락된 경우
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

매핑 삭제

엔드포인트: DELETE /v1/tenant/{tenantId}/processes/{processId}/mappings/{mappingId}

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
mappingId string 경로 예 형식: uuid

응답(200):

매핑을 삭제했습니다

{
	"success": true,
	"message": "string"
}
필드 유형 필수 설명
success boolean 예
message string 예

오류:

  • 400 잘못된 요청: 필터 표현식이 유효하지 않거나, 모델이 없는 프로세스이거나, 지원하지 않는 파일 형식이거나, 필수 필드가 누락된 경우
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

이 엔드포인트는 AI를 사용해 자연어 설명으로 BPMN 프로세스 모델을 자동 생성합니다.

자연어 프롬프트로 프로세스 모델 생성(비동기, 상태 엔드포인트에서 진행 상황 확인)

엔드포인트: POST /v1/tenant/{tenantId}/processes/{processId}/generate-model

인증: 테넌트 범위 API 키 · write 범위 · 요청 제한 초당 2회(최대 4회)

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

요청 본문:

{
	"prompt": "string"
}
필드 유형 필수 설명
prompt string 예

응답(200):

생성 시작됨 / 결과

{
	"message": "string"
}
필드 유형 필수 설명
message string 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

모델 생성 상태 확인

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/generate-model/status

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

응답(200):

생성 상태

{
	"message": "string"
}
필드 유형 필수 설명
message string 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

프로세스의 최신 모델에서 계산한 케이스별 지표입니다. 케이스마다 한 행에 계산된 시퀀스 및 상태 지표가 표시됩니다.

프로세스의 케이스별 지표 조회(최신 모델, 페이지 단위)

프로세스의 최신 모델에서 계산한 프로세스 지표(케이스 기간, 길이, 적합성, 재작업, 상태 점수, 변형 등)를 케이스별 한 행으로 반환합니다. 행 필터링은 적용되지 않습니다. 결과는 페이지 단위로 반환됩니다. limit를 사용하고(기본값 1000, 최댓값 10000), offset를 지정한 뒤 hasMore가 true인 동안 다음 페이지를 계속 요청합니다. 지표 계산이 진행 중이면 응답 상태는 preprocessing입니다.

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/data/case-features

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
limit integer 쿼리 아니요 반환할 케이스 행의 최대 개수(기본값 1000, 최댓값 10000)
offset integer 쿼리 아니요 건너뛸 케이스 행 수(기본값 0)

응답(200):

케이스 지표

{
	"state": "ready",
	"processId": "00000000-0000-0000-0000-000000000000",
	"modelId": "00000000-0000-0000-0000-000000000000",
	"dataTableId": "00000000-0000-0000-0000-000000000000",
	"rowCount": 0,
	"hasMore": true,
	"rows": [
		{}
	]
}

오류:

  • 400 잘못된 요청: 필터 표현식이 유효하지 않거나, 모델이 없는 프로세스이거나, 지원하지 않는 파일 형식이거나, 필수 필드가 누락된 경우
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음
  • 503 데이터 파이프라인이 준비되지 않았거나 상위 쿼리 실행에 실패한 경우

프로세스 버전 목록 조회

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/versions

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
limit integer 쿼리 아니요 반환할 항목의 최대 개수
offset integer 쿼리 아니요 건너뛸 항목 수

응답(200):

버전 목록

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
]

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

프로세스 버전 스냅샷 생성

엔드포인트: POST /v1/tenant/{tenantId}/processes/{processId}/versions

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

요청 본문:

{
	"displayName": "string",
	"description": "string",
	"versionType": "manual",
	"restoreFromVersionId": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
displayName string 아니요 버전 이름
기본값: ""
최대 길이: 128
description string 아니요 버전에 대한 선택적 설명
versionType manual | auto 아니요 수동 = 사용자가 생성, auto = 시스템에서 생성
허용 값: manual, auto
restoreFromVersionId string 아니요 이 스냅샷을 만들 때 복원할 버전
형식: uuid

응답(201):

버전을 생성했습니다

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	},
	"restoredFrom": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}
필드 유형 필수 설명
version object 예
restoredFrom object 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

프로세스 버전 조회

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
versionId string 경로 예 형식: uuid

응답(200):

버전

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}
필드 유형 필수 설명
version object 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

프로세스 버전 이름 또는 정보 업데이트

엔드포인트: PUT /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
versionId string 경로 예 형식: uuid

요청 본문:

{
	"displayName": "string",
	"description": "string"
}
필드 유형 필수 설명
displayName string 아니요 버전 이름
최대 길이: 128
description string 아니요 버전에 대한 선택 설명

응답(200):

버전을 업데이트했습니다

{
	"version": {
		"id": "00000000-0000-0000-0000-000000000000",
		"processId": "00000000-0000-0000-0000-000000000000",
		"modelId": "00000000-0000-0000-0000-000000000000",
		"versionNumber": 0,
		"versionType": "manual",
		"displayName": "string",
		"description": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"updatedAt": "2024-03-15T16:30:00Z",
		"processDisplayName": "string",
		"processShortDescription": "string",
		"publishedState": "draft",
		"elementCount": 0,
		"connectionCount": 0
	}
}
필드 유형 필수 설명
version object 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

프로세스 버전 삭제

엔드포인트: DELETE /v1/tenant/{tenantId}/processes/{processId}/versions/{versionId}

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
versionId string 경로 예 형식: uuid

응답(200):

버전을 삭제했습니다

{
	"deleted": true
}
필드 유형 필수 설명
deleted boolean 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

아티팩트 조회

엔드포인트: GET /v1/tenant/{tenantId}/artifacts/{artifactId}

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
artifactId string 경로 예 형식: uuid

응답(200):

아티팩트

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
id string 예 형식: uuid
displayName string 예 기본값: ""
최대 길이: 500
description string 예 최대 길이: 2000
originalFileName string 예 기본값: ""
최대 길이: 500
mimeType string 예 기본값: ""
최대 길이: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video 예 허용 값: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage 예 허용 값: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
기본값: modelIcon
uploadState Uploading | Ready | Failed | Deleted 예 허용 값: Uploading, Ready, Failed, Deleted
기본값: Uploading
hasThumbnail boolean 예 기본값: false
sizeBytes number 예 기본값: 0
createdAt string 예 형식: date-time
createdBy string 아니요 형식: uuid

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

아티팩트의 표시 이름 또는 설명 업데이트

엔드포인트: PUT /v1/tenant/{tenantId}/artifacts/{artifactId}

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
artifactId string 경로 예 형식: uuid

요청 본문:

{
	"displayName": "string",
	"description": "string"
}
필드 유형 필수 설명
displayName string 아니요 아티팩트 이름
최대 길이: 500
description string 아니요 아티팩트에 대한 선택 설명
최대 길이: 2000

응답(200):

아티팩트를 업데이트했습니다

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"description": "string",
	"originalFileName": "string",
	"mimeType": "string",
	"kind": "Image",
	"artifactType": "modelIcon",
	"uploadState": "Uploading",
	"hasThumbnail": true,
	"sizeBytes": 0,
	"createdAt": "2024-03-15T16:30:00Z",
	"createdBy": "00000000-0000-0000-0000-000000000000"
}
필드 유형 필수 설명
id string 예 형식: uuid
displayName string 예 기본값: ""
최대 길이: 500
description string 예 최대 길이: 2000
originalFileName string 예 기본값: ""
최대 길이: 500
mimeType string 예 기본값: ""
최대 길이: 200
kind Image | Pdf | Docx | Xlsx | Pptx | Text | Video 예 허용 값: Image, Pdf, Docx, Xlsx, Pptx, Text, Video
artifactType modelIcon | processArtifact | doc | orgDoc | levelFrontPageImage 예 허용 값: modelIcon, processArtifact, doc, orgDoc, levelFrontPageImage
기본값: modelIcon
uploadState Uploading | Ready | Failed | Deleted 예 허용 값: Uploading, Ready, Failed, Deleted
기본값: Uploading
hasThumbnail boolean 예 기본값: false
sizeBytes number 예 기본값: 0
createdAt string 예 형식: date-time
createdBy string 아니요 형식: uuid

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

아티팩트 삭제

엔드포인트: DELETE /v1/tenant/{tenantId}/artifacts/{artifactId}

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
artifactId string 경로 예 형식: uuid

응답(200):

아티팩트를 삭제했습니다

{
	"deleted": true
}
필드 유형 필수 설명
deleted boolean 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

아티팩트 다운로드용 사전 서명 URL로 리디렉션

엔드포인트: GET /v1/tenant/{tenantId}/artifacts/{artifactId}/open

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
artifactId string 경로 예 형식: uuid

오류:

  • 302 사전 서명된 다운로드 URL로 리디렉션
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

프로세스에 연결된 아티팩트 목록 조회

엔드포인트: GET /v1/tenant/{tenantId}/processes/{processId}/artifacts

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid
limit integer 쿼리 아니요 반환할 항목의 최대 개수
offset integer 쿼리 아니요 건너뛸 항목 수

응답(200):

프로세스 아티팩트 목록

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"artifactId": "00000000-0000-0000-0000-000000000000",
		"section": "string",
		"artifact": {
			"id": "00000000-0000-0000-0000-000000000000",
			"displayName": "string",
			"description": "string",
			"originalFileName": "string",
			"mimeType": "string",
			"kind": "Image",
			"artifactType": "modelIcon",
			"uploadState": "Uploading",
			"hasThumbnail": true,
			"sizeBytes": 0,
			"createdAt": "2024-03-15T16:30:00Z",
			"createdBy": "00000000-0000-0000-0000-000000000000"
		}
	}
]

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 404 리소스를 찾을 수 없음

새 프로세스 아티팩트용 사전 서명 S3 업로드 URL 조회

엔드포인트: POST /v1/tenant/{tenantId}/processes/{processId}/artifacts/uploads/presigned-url

인증: 테넌트 범위 API 키 · write 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid
processId string 경로 예 형식: uuid

요청 본문:

{
	"fileName": "string",
	"mimeType": "string",
	"sizeBytes": 0,
	"artifactType": "modelIcon"
}
필드 유형 필수 설명
fileName string 예
mimeType string 예
sizeBytes number 예
artifactType modelIcon | processArtifact | doc | levelFrontPageImage 아니요 허용 값: modelIcon, processArtifact, doc, levelFrontPageImage
기본값: processArtifact

응답(200):

사전 서명된 업로드 URL

{
	"artifactId": "00000000-0000-0000-0000-000000000000",
	"originalUrl": "string",
	"thumbnailUrl": "string"
}
필드 유형 필수 설명
artifactId string 예 형식: uuid
originalUrl string 예
thumbnailUrl string 예

오류:

  • 400 잘못된 요청: 필터 표현식이 유효하지 않거나, 모델이 없는 프로세스이거나, 지원하지 않는 파일 형식이거나, 필수 필드가 누락된 경우
  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 403 API 키에 필요한 범위 또는 조직 접근 권한이 없거나, 테넌트가 비활성 상태이거나, 요금제가 해당 파일 형식을 지원하지 않는 경우
  • 404 리소스를 찾을 수 없음
  • 409 현재 상태와 요청이 충돌하는 경우(예: 라이선스 제한 또는 ID 재사용)

관련 문서

더 나은 프로세스를 설계하고, 연결된 아키텍처를 구축해 관리하세요.

신용카드 등록이나 대기 없이 바로 이용할 수 있습니다. 조직의 업무 방식을 명확하고 유기적으로 연결된 프로세스 설계로 바꿔 보세요.

프로세스 아키텍처를 구축하고, 소유권과 통제 기준을 정립하며, 모든 계층의 역할과 책임을 조율하세요.

무료 체험을 시작하고 프로세스를 관리·운영하고 지속적으로 개선할 수 있는 신뢰할 만한 기반을 마련하세요.

오늘 무료 체험 시작하기