셀로니스(미리 보기)
레코드, KPI, 필터, 트리거 및 관련 데이터와 같은 기술 모델 요소를 사용하는 Celonis Platform API입니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | Celonis 지원 |
| URL | https://developer.celonis.com/ |
| 전자 메일 | intelligence-api-feedback-sc@celonis.de |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | 셀로니스 주 |
| 웹 사이트 | https://www.celonis.com |
| 개인 정보 보호 정책 | https://www.celonis.com/privacy-policy/ |
| 카테고리 | AI; 비즈니스 관리 |
제목
Celonis Intelligence API를 통해 Celonis 고객은 최종 사용자가 Celonis 프로세스 인사이트를 활용할 수 있는 타사 플랫폼에 실행 가능한 프로세스 인텔리전스를 포함할 수 있습니다. 이러한 방식으로 프로세스 KPI 또는 프로세스 비효율성과 같은 Celonis 인텔리전스를 최종 사용자에게 더 가깝게 가져오고, 일상적인 활동을 실행하는 동안 더 나은 의사 결정을 위한 귀중한 인사이트를 제공하여 Celonis에 대한 현재 액세스 없이 운영 사용자에게 혜택을 줄 수 있습니다. 데이터 쿼리 기능 외에도 Intelligence API는 비즈니스 트리거를 구독할 수 있도록 하여 타사 플랫폼에 데이터 푸시를 지원합니다.
게시자: 게시자의 이름
필수 조건
- Celonis Platform의 팀입니다.
- 클라이언트 팀에서 사용할 수 있는 지식 모델 입니다.
- 프로세스 기반 Celonis 구독(확인하려면 계정 팀에 문의).
지원되는 작업
현재 API 메서드를 사용하면 소비자가 다음 기능을 제공하여 Celonis Platform에 정의된 지식 모델과 상호 작용할 수 있습니다.
지식 모델 검색 방법
KM(지식 모델) 목록 가져오기
KM 레코드 목록 가져오기
KM 레코드 스키마 세부 정보 가져오기
KM 필터 목록 가져오기
지식 모델 데이터 검색 방법
KM 레코드 데이터 목록 가져오기
구독 수명 주기 관리 방법
구독 목록 가져오기
KM 트리거 목록 가져오기
KM 트리거에 대한 구독 만들기
구독 업데이트
구독 일시 중지
구독 다시 시작
구독 종료
자격 증명 가져오기
Authentication
API에 대한 각 요청은 Celonis API 키로 인증되어야 합니다. 이 작업을 수행하는 방법에는 두 가지가 있습니다.
사용자 API 키 사용
사용자 API 키 가이드에 따라 사용자 API 키를 만드는 방법을 확인할 수 있습니다. Celonis API는 소비자 액세스를 확인하기 위해 전달자 토큰 인증을 사용합니다. 자격 증명은 HTTP 요청의 권한 부여 헤더로 전송되어야 합니다. 요청의 URL 또는 본문에 전송된 자격 증명은 무시됩니다. 전달자 토큰 인증을 사용하여 인증하려면:
- Celonis에서 토큰을 만듭니다.
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - 다음과 같이 형식이 지정된 HTTP 권한 부여 헤더에 문자열을 포함합니다.
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
애플리케이션 API 키 사용
애플리케이션 API 키 가이드에 따라 AppKey를 만드는 방법을 확인할 수 있습니다. AppKey 인증을 사용하여 인증하려면 다음을 수행합니다.
- Celonis에서 AppKey를 만듭니다.
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - 다음과 같이 형식이 지정된 HTTP 권한 부여 헤더에 문자열을 포함합니다.
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
올바른 권한을 설정하고 권한 부여 목적으로 활용된 사용자 API 키 또는 애플리케이션 API 키가 Intelligence API를 통해 액세스하려는 지식 모델이 포함된 Celonis Studio 패키지에 액세스할 수 있는지 확인해야 합니다. 다음 단계에 따라 액세스 권한을 부여할 수 있습니다.
- Studio 패키지로 이동합니다.
- 세 개의 점을 클릭하고 팝업 메뉴에서 선택합니다
Permissions. - 사용자( 전달자 토큰 을 사용하는 경우) 또는 AppKey( AppKey 를 사용하는 경우)를 검색하고 최소한
USE PACKAGE권한을 부여합니다.
시작하기
Celonis API의 기본 URL은 https://<team>.<cluster>.celonis.cloud/intelligence/api 팀과 클러스터를 찾으려면 Celonis 플랫폼에 액세스하는 데 사용하는 URL을 확인하고 팀에서 팀과 클러스터를 검색하세요.
Celonis Intelligence API는 JSON API이며 해당 엔드포인트는 요청의 성공에 관계없이 항상 JSON 응답을 반환합니다.
현재 API 메서드를 사용하면 소비자가 다음 기능을 제공하여 Celonis Platform에 정의된 지식 모델과 상호 작용할 수 있습니다.
- 사용 가능한 지식 모델 및 세부 정보 목록
- 레코드 목록 및 세부 정보
- 필터 목록
- 특정 레코드에 대한 데이터입니다. Celonis 개발자 포털의 Celonis Intelligence API 기능에 대한 세부 정보입니다.
알려진 문제 및 제한 사항
속도 제한
Intelligence API는 RAW 데이터를 대량으로 내보내는 것이 아니라 프로세스 마이닝의 계산된 결과와 인사이트를 타사 플랫폼 및 애플리케이션에서 사용할 수 있도록 하기 위해 빌드되었습니다. 이것이 바로 Celonis API가 속도 제한을 적용하는 이유입니다. 즉, 하루에 특정 수의 요청만 허용되며 각 호출에서 특정 수의 레코드를 검색할 수 있습니다. Celonis는 모든 클라이언트에 대해 고품질 서비스를 보장하기 위해 언제든지 속도 제한을 조정할 수 있는 권리를 보유합니다.
클라이언트가 반복적으로 속도 제한을 초과하거나 의심스러운 것으로 간주되는 동작에 관여하는 경우 Celonis는 해당 클라이언트에 대한 API에 대한 액세스를 일시적으로 또는 영구적으로 제한하거나 일시 중단할 수 있는 권한을 보유합니다.
클라이언트가 일일 요청 수를 초과하면 Celonis API는 새 요청을 처리하기 전에 클라이언트가 기다려야 하는 시간(초)을 나타내는 HTTP 헤더()를 포함하여 429개 응답(x-ratelimit-reset너무 많은 요청)을 반환합니다.
다음 HTTP 헤더도 각 호출의 일부로 반환됩니다.
-
x-ratelimit-limit: 클라이언트가 현재 시간 창에서 수행할 수 있는 최대 요청 수를 나타냅니다. -
x-ratelimit-remaining: 현재 기간의 나머지 요청 수입니다. 현재 API에는 다음과 같은 기본 제한이 있습니다.
표 1. 기본 요청 속도 제한
|
한계 | 기본값 | |--|--| | 최대 요청 수/일 | 6000 requests/day | | 최대 요청 수/초 | 20 requests/second | | 기술 모델에서 요청당 허용되는 최대 필드 수 | 200 fields/request | | 엔드포인트를 호출 /data 할 때 반환되는 요청당 최대 레코드 수 | 50 레코드/요청 | | 엔드포인트를 통해 /data 검색할 수 있는 총 최대 레코드 수 | 필터링/정렬된 테이블당 첫 번째 5.000 레코드 | 트리거 구독도 속도 제한을 적용합니다. 즉, 팀의 경우 특정 수의 구독만 만들 수 있습니다. 또한 생성되는 구독 수에 관계없이 API에서 타사 소비자에게 내보낼 수 있는 최대 이벤트 수가 있습니다.
클라이언트가 최대 구독 수에 도달하면 새 구독을 만들려면 기존 구독을 삭제해야 합니다.
클라이언트가 API에서 내보낸 최대 이벤트 수에 도달하면 Celonis Platform에서 생성된 나머지 데이터는 삭제됩니다.
클라이언트가 일일 할당량에 근접하는 경우 관리자 계정에 대한 전자 메일을 통해 알려 줍니다. 할당량의 80% 초과하면 첫 번째 전자 메일이 전송되어 관리자 계정에 해당 비율을 초과했음을 알 수 있습니다. 두 번째 전자 메일은 할당량의% 100을 초과하는 즉시 전송됩니다.
현재 API에는 다음과 같은 기본 제한이 있습니다.
표 2. 기본 이벤트 속도 제한
|
한계 | 기본값 | |--|--| | 최대 구독 수/팀 | 10 | | 최대 이벤트 수/일 | 100,000 | 팀의 한도를 확인하려면 계정 팀에 문의하세요.
자주 묻는 질문
Celonis 개발자 포털의 질문과 대답 섹션을 참조하세요.
배포 지침
필수 사항입니다. 이 커넥터를 사용자 지정 커넥터로 배포하는 방법에 대한 지침을 추가합니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 팀 | 문자열 | Celonis 팀을 지정하세요. | 진실 |
| Cluster | 문자열 | Celonis 클러스터를 지정하세요. | 진실 |
| Authorization | 시큐어스트링 (보안 문자열) | 이 API에 대한 권한 부여 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| KM 레코드 데이터 목록 가져오기 |
지식 모델의 레코드에 대한 데이터 |
| KM 레코드 스키마 목록 가져오기 |
레코드 스키마 목록 |
| KM 목록 가져오기 |
EMS 팀에 정의된 지식 모델 목록 |
| KM 트리거 목록 가져오기 |
기술 모델에 대한 트리거 목록 |
| KM 필터 목록 가져오기 |
지식 모델에 대한 필터 목록 |
| 구독 목록 가져오기 |
만든 모든 구독 목록 |
| 구독 업데이트 |
구독 업데이트 |
| 구독에 대한 모든 데이터를 제거하는 트리거에서 구독 취소 |
구독에 대한 모든 데이터를 제거하는 트리거에서 구독 취소 |
| 구독을 다시 시작하여 새 이벤트 수신을 시작하고 기록 이벤트를 삭제합니다. |
일시 중지된 구독을 다시 시작하여 새 이벤트 수신을 다시 시작하고 기록 이벤트를 삭제합니다. |
| 구독을 일시 중지하여 이벤트 수신 중지 |
구독을 일시 중지하여 이벤트 수신 중지 |
| 실패한 구독으로 인해 전달되지 않은 이벤트의 다음 페이지를 검색합니다. |
실패한 구독으로 인해 전달되지 않은 경우 이벤트의 다음 페이지를 검색합니다. |
| 일시 중지된 구독을 다시 시작하여 이벤트 수신을 다시 시작합니다. |
일시 중지된 구독을 다시 시작하여 이벤트 수신을 다시 시작합니다. |
| 최상위 KM 레코드 스키마 세부 정보 가져오기 |
최상위 레코드 스키마 세부 정보 |
| 최상위 KM 세부 정보 가져오기 |
EMS 팀에 정의된 지식 모델 |
| 트리거에 대한 구독을 만듭니다. |
트리거에 대한 구독을 만듭니다. |
KM 레코드 데이터 목록 가져오기
지식 모델의 레코드에 대한 데이터
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
지식 모델 ID
|
km_id | True | string |
지식 모델 ID |
|
레코드 ID
|
record_id | True | string |
레코드 ID |
|
필터
|
filters | array |
미리 정의된 필터 ID |
|
|
필드 ID
|
fields | True | array |
미리 정의된 필터 ID |
|
페이지
|
page | integer |
0부터 시작하는 결과의 페이지 번호(첫 번째 페이지) |
|
|
페이지 크기
|
pageSize | integer |
페이지에 반환된 항목 수입니다. |
|
|
정렬
|
sort | array |
정렬을 진행하기 위한 전략을 정의합니다. 쉼표로 구분된 필드 목록이어야 하며 ASC 순서를 적용하려면 "+"로 시작하거나 DESC 순서를 적용하려면 "-"로 시작해야 합니다. 접두사 없는 필드는 ASC로 정렬됩니다. 헤더에 기존 필드가 없으면 오류가 발생합니다. |
|
|
필터 식
|
filterExpr | array |
동적 필터 식 |
반환
- 레코드 데이터 결과 페이지
- recordResultPageDTO
KM 레코드 스키마 목록 가져오기
레코드 스키마 목록
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
페이지
|
page | integer |
0부터 시작하는 결과의 페이지 번호(첫 번째 페이지) |
|
|
페이지 크기
|
pageSize | integer |
페이지에 반환된 항목 수입니다. |
|
|
정렬
|
sort | string |
대/소문자를 구분하지 않는 정렬을 진행하는 전략을 정의합니다. 하나의 필드여야 하며 ASC 순서를 적용하려면 "+"로 시작하거나 DESC 순서를 적용하려면 "-"로 시작해야 합니다. 접두사는 ASC로 정렬됩니다. 헤더에 기존 필드가 없으면 오류가 발생합니다. |
|
|
지식 모델 ID
|
km_id | True | string |
지식 모델 ID |
반환
- 레코드 스키마 결과 페이지
- recordSchemaResultPage
KM 목록 가져오기
EMS 팀에 정의된 지식 모델 목록
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
페이지
|
page | integer |
0부터 시작하는 결과의 페이지 번호(첫 번째 페이지) |
|
|
페이지 크기
|
pageSize | integer |
페이지에 반환된 항목 수입니다. |
|
|
정렬
|
sort | string |
대/소문자를 구분하지 않는 정렬을 진행하는 전략을 정의합니다. 하나의 필드여야 하며 ASC 순서를 적용하려면 "+"로 시작하거나 DESC 순서를 적용하려면 "-"로 시작해야 합니다. 접두사는 ASC로 정렬됩니다. 헤더에 기존 필드가 없으면 오류가 발생합니다. |
반환
- KnowledgeModel 결과 페이지
- knowledgeModelResultPage
KM 트리거 목록 가져오기
기술 모델에 대한 트리거 목록
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
페이지
|
page | integer |
0부터 시작하는 결과의 페이지 번호(첫 번째 페이지) |
|
|
페이지 크기
|
pageSize | integer |
페이지에 반환된 항목 수입니다. |
|
|
Sort
|
sort | string |
대/소문자를 구분하지 않는 정렬을 진행하는 전략을 정의합니다. 하나의 필드여야 하며 ASC 순서를 적용하려면 "+"로 시작하거나 DESC 순서를 적용하려면 "-"로 시작해야 합니다. 접두사는 ASC로 정렬됩니다. 헤더에 기존 필드가 없으면 오류가 발생합니다. |
|
|
Km Id
|
km_id | True | string |
지식 모델 ID |
반환
- 트리거 스키마 결과 페이지
- triggerResultPage
KM 필터 목록 가져오기
지식 모델에 대한 필터 목록
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
페이지
|
page | integer |
0부터 시작하는 결과의 페이지 번호(첫 번째 페이지) |
|
|
페이지 크기
|
pageSize | integer |
페이지에 반환된 항목 수입니다. |
|
|
정렬
|
sort | string |
대/소문자를 구분하지 않는 정렬을 진행하는 전략을 정의합니다. 하나의 필드여야 하며 ASC 순서를 적용하려면 "+"로 시작하거나 DESC 순서를 적용하려면 "-"로 시작해야 합니다. 접두사는 ASC로 정렬됩니다. 헤더에 기존 필드가 없으면 오류가 발생합니다. |
|
|
지식 모델 ID
|
km_id | True | string |
지식 모델 ID |
반환
- 필터 스키마 결과 페이지
- filterResultPage
구독 목록 가져오기
만든 모든 구독 목록
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
페이지
|
page | integer |
0부터 시작하는 결과의 페이지 번호(첫 번째 페이지) |
|
|
페이지 크기
|
pageSize | integer |
페이지에 반환된 항목 수입니다. |
|
|
Sort
|
sort | string |
대/소문자를 구분하지 않는 정렬을 진행하는 전략을 정의합니다. 하나의 필드여야 하며 ASC 순서를 적용하려면 "+"로 시작하거나 DESC 순서를 적용하려면 "-"로 시작해야 합니다. 접두사는 ASC로 정렬됩니다. 헤더에 기존 필드가 없으면 오류가 발생합니다. |
반환
- 구독 스키마 결과 페이지
- subscriptionResultPage
구독 업데이트
구독 업데이트
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구독 ID
|
subscription_id | True | string |
완전히 업데이트될 구독 ID |
|
headers
|
headers | object |
콜백 헤더에는 인증 토큰, 콘텐츠 형식 등이 포함될 수 있습니다. |
|
|
protocol
|
protocol | True | string |
실제로 가능한 값만 HTTPS입니다. 즉, 콜백 URI는 유효한 https여야 합니다. |
|
URI
|
uri | True | string |
트리거가 실행되면 Intelligence API에서 콜백을 수행하는 URI |
|
구성
|
configurations | array of string |
구독에 대한 구성 |
|
|
이름
|
name | True | string |
구독의 이름 |
구독에 대한 모든 데이터를 제거하는 트리거에서 구독 취소
구독에 대한 모든 데이터를 제거하는 트리거에서 구독 취소
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구독 ID
|
subscription_id | True | string |
구독 ID가 삭제됩니다. |
구독을 다시 시작하여 새 이벤트 수신을 시작하고 기록 이벤트를 삭제합니다.
일시 중지된 구독을 다시 시작하여 새 이벤트 수신을 다시 시작하고 기록 이벤트를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구독 ID
|
subscription_id | True | string |
전달된 이벤트를 수신하지 않고 구독 ID가 다시 시작됩니다. |
구독을 일시 중지하여 이벤트 수신 중지
구독을 일시 중지하여 이벤트 수신 중지
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구독 ID
|
subscription_id | True | string |
구독 ID가 일시 중지됩니다. |
실패한 구독으로 인해 전달되지 않은 이벤트의 다음 페이지를 검색합니다.
실패한 구독으로 인해 전달되지 않은 경우 이벤트의 다음 페이지를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구독 ID
|
subscription_id | True | string |
최대 50개 항목으로 전송된 실패한 이벤트를 검색할 구독 ID입니다. |
반환
- 신호 결과 페이지
- SignalResultPage
일시 중지된 구독을 다시 시작하여 이벤트 수신을 다시 시작합니다.
일시 중지된 구독을 다시 시작하여 이벤트 수신을 다시 시작합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구독 ID
|
subscription_id | True | string |
구독 ID가 다시 시작되고 이벤트 수신이 다시 시작됩니다. |
최상위 KM 레코드 스키마 세부 정보 가져오기
최상위 레코드 스키마 세부 정보
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
지식 모델 ID
|
km_id | True | string |
지식 모델 ID |
|
레코드 ID
|
record_id | True | string |
레코드 ID |
반환
레코드는 기술 모델 내의 개념을 나타냅니다.
- 레코드 유형
- recordDTO
최상위 KM 세부 정보 가져오기
EMS 팀에 정의된 지식 모델
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
지식 모델 ID
|
km_id | True | string |
지식 모델 ID |
반환
지식 모델 데이터의 구조
트리거에 대한 구독을 만듭니다.
트리거에 대한 구독을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Km Id
|
km_id | True | string |
지식 모델 ID |
|
트리거 ID
|
trigger_id | True | string |
트리거 ID |
|
headers
|
headers | object |
콜백 헤더에는 인증 토큰, 콘텐츠 형식 등이 포함될 수 있습니다. |
|
|
protocol
|
protocol | True | string |
실제로 가능한 값만 HTTPS입니다. 즉, 콜백 URI는 유효한 https여야 합니다. |
|
URI
|
uri | True | string |
트리거가 실행되면 Intelligence API에서 콜백을 수행하는 URI |
|
구성
|
configurations | array of string |
구독에 대한 구성 |
|
|
이름
|
name | True | string |
구독의 이름 |
반환
- response
- string
정의
SignalResultPage
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
내용
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
시스템에서 정의한 페이지 크기 |
filterDTO
KM에서 적용할 필터
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
description
|
description | string |
사람이 이해할 수 있는 필터 설명 |
|
아이디
|
id | string |
필터의 고유 식별자 |
|
이름
|
name | string |
사람이 이해할 수 있는 필터 표시 이름 |
filterResultPage
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
page
|
page | integer |
페이지 |
|
pageSize
|
pageSize | integer |
pageSize 매개 변수로 정의된 페이지 크기 |
|
sort
|
sort | string |
요청된 데이터에 정렬을 적용하는 데 사용되는 필드이거나 기호가 ASC를 의미하지 않음 - DESC를 의미합니다. |
|
합계
|
total | integer |
페이지에 반환된 총 요소 |
|
내용
|
content | array of filterDTO |
knowledgeModelDetailedDTO
지식 모델 데이터의 구조
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
지식 모델의 고유 식별자 |
|
이름
|
name | string |
사람이 이해할 수 있는 텍스트 |
|
extendedKMId
|
extendedKMId | string |
참조, KM 베이스로 사용되는 지식 모델입니다. |
knowledgeModelResultPage
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
page
|
page | integer |
페이지 |
|
pageSize
|
pageSize | integer |
pageSize 매개 변수로 정의된 페이지 크기 |
|
sort
|
sort | string |
요청된 데이터에 정렬을 적용하는 데 사용되는 필드이거나 기호가 ASC를 의미하지 않음 - DESC를 의미합니다. |
|
합계
|
total | integer |
페이지에 반환된 총 요소 |
|
내용
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
지식 모델 데이터의 구조
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
지식 모델의 고유 식별자 |
|
이름
|
name | string |
사람이 이해할 수 있는 텍스트 |
|
게시
|
published | string |
최근 게시된 날짜 |
recordDTO
레코드는 기술 모델 내의 개념을 나타냅니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
description
|
description | string |
레코드 설명 |
|
아이디
|
id | string |
레코드의 고유 식별자 |
|
이름
|
name | string |
레코드 표시 이름, 사람이 이해할 수 있는 이름 |
|
fields
|
fields | array of recordFieldDTO |
recordFieldDTO
레코드의 필드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
format
|
format | string |
적용할 형식 |
|
아이디
|
id | string |
결제 보류 중인 금액 |
|
이름
|
name | string |
사람이 이해할 수 있는 이름 |
|
type
|
type | string | |
|
단위
|
unit | string |
필드 값에 추가된 단위 |
recordIdDTO
레코드 형식의 ID 및 이름
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
description
|
description | string |
레코드 설명 |
|
아이디
|
id | string |
레코드의 고유 식별자 |
|
이름
|
name | string |
레코드 표시 이름, 사람이 이해할 수 있는 이름 |
recordItemDTO
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
데이터
|
data | array of |
레코드 항목 목록, 이름 및 값이 포함된 복합 항목 |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
집합체
|
aggregation | boolean |
필드가 KPI(집계/계산 정보)인지 여부를 나타냅니다. |
|
filterable
|
filterable | boolean |
필드를 필터링할 수 있는지 여부를 나타냅니다. |
|
format
|
format | string |
형식 식 |
|
아이디
|
id | string |
필드 목록 매개 변수 및 filterExpression 매개 변수에 사용할 필드 ID |
|
이름
|
name | string |
사람이 이해할 수 있는 텍스트 |
|
sortable
|
sortable | boolean |
필드를 정렬할 수 있는지 여부를 나타냅니다. |
|
type
|
type | string |
가능한 데이터 형식입니다. |
|
단위
|
unit | string |
서식 값 보기에 대한 보완 기호 |
recordResultPageDTO
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
page
|
page | integer |
페이지 |
|
pageSize
|
pageSize | integer |
pageSize 매개 변수로 정의된 페이지 크기 |
|
sort
|
sort | array of string | |
|
합계
|
total | integer |
페이지에 반환된 총 요소 |
|
레코드 항목
|
content | recordItemDTO |
recordSchemaResultPage
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
page
|
page | integer |
페이지 |
|
pageSize
|
pageSize | integer |
pageSize 매개 변수로 정의된 페이지 크기 |
|
sort
|
sort | string |
요청된 데이터에 정렬을 적용하는 데 사용되는 필드이거나 기호가 ASC를 의미하지 않음 - DESC를 의미합니다. |
|
합계
|
total | integer |
페이지에 반환된 총 요소 |
|
내용
|
content | array of recordIdDTO |
signalDTO
구독에 저장된 신호
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
signal
|
signal | string |
신호의 원시 json |
|
subscriptionId
|
subscriptionId | string |
구독자의 고유 식별자를 SUID로 |
|
triggerId
|
triggerId | string |
SUID로 트리거의 고유 식별자 |
|
생성일
|
creationDate | date-time |
신호 생성 날짜 |
subscriptionDTO
구독 스키마
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
구성
|
configurations | array of string |
구독에 대한 구성 |
|
아이디
|
id | string |
구독자의 고유 식별자를 SUID로 |
|
knowledgeModelId
|
knowledgeModelId | string |
지식 모델의 고유 식별자 |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
마지막으로 성공한 이벤트의 날짜 |
|
이름
|
name | string |
사람이 이해할 수 있는 구독 이름 |
|
status
|
status | string | |
|
triggerId
|
triggerId | string |
SUID로 트리거의 고유 식별자 |
subscriptionResultPage
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
page
|
page | integer |
페이지 |
|
pageSize
|
pageSize | integer |
pageSize 매개 변수로 정의된 페이지 크기 |
|
sort
|
sort | string |
요청된 데이터에 정렬을 적용하는 데 사용되는 필드이거나 기호가 ASC를 의미하지 않음 - DESC를 의미합니다. |
|
합계
|
total | integer |
페이지에 반환된 총 요소 |
|
내용
|
content | array of subscriptionDTO |
triggerDTO
KM에서 정의된 트리거
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
SUID로 트리거의 고유 식별자 |
|
이름
|
name | string |
사람이 이해할 수 있는 트리거 이름 |
|
기록
|
record | string |
레코드의 고유 식별자를 SUID로 |
triggerResultPage
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
page
|
page | integer |
페이지 |
|
pageSize
|
pageSize | integer |
pageSize 매개 변수로 정의된 페이지 크기 |
|
sort
|
sort | string |
요청된 데이터에 정렬을 적용하는 데 사용되는 필드이거나 기호가 ASC를 의미하지 않음 - DESC를 의미합니다. |
|
합계
|
total | integer |
페이지에 반환된 총 요소 |
|
내용
|
content | array of triggerDTO |
문자열
기본 데이터 형식 'string'입니다.