dataset-syncs
dataset-syncs API, 엔드포인트 9개 (자동 생성)
POST /api/v1/datasets:from-external
POST/api/v1/datasets:from-external
외부 소스로부터 데이터셋 생성
외부 소스의 원격 데이터셋을 받아올 데이터셋 생성.
필요 권한: DATASET_WRITE
요청 본문: application/json, FromExternalCreate
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
source_id | string | ✓ | 등록된 외부 소스 id |
remote_dataset_id | string | ✓ | 원격 서버가 부르는 데이터셋 id |
name | string? | Name | |
modality | string? | Modality | |
sync_now | boolean | Sync Now |
응답
| 상태 | 설명 |
|---|---|
| 201 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/datasets/{dataset_id}/source
GET/api/v1/datasets/{dataset_id}/source
데이터셋 소스 연결 조회
데이터셋의 외부 소스 연결 상태 반환 (VIEW 권한).
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
PUT /api/v1/datasets/{dataset_id}/source
PUT/api/v1/datasets/{dataset_id}/source
데이터셋 소스 연결
이미 있는 데이터셋을 외부 소스에 연결(또는 연결 변경).
필요 권한: DATASET_WRITE
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ |
요청 본문: application/json, SourceLink
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
source_id | string | ✓ | Source Id |
remote_dataset_id | string | ✓ | Remote Dataset Id |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
DELETE /api/v1/datasets/{dataset_id}/source
DELETE/api/v1/datasets/{dataset_id}/source
데이터셋 소스 연결 해제
소스 연결 해제.
필요 권한: DATASET_WRITE
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/datasets/{dataset_id}/syncs
GET/api/v1/datasets/{dataset_id}/syncs
동기화 이력
데이터셋의 동기화 실행 이력을 최신순으로 반환 (VIEW 권한).
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ | |
page | query | integer | ||
page_size | query | integer? |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/datasets/{dataset_id}/syncs
POST/api/v1/datasets/{dataset_id}/syncs
동기화 실행
연결된 외부 소스로부터 동기화 시작 (202).
필요 권한: DATASET_WRITE
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 202 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/datasets/{dataset_id}/syncs/{sync_id}
GET/api/v1/datasets/{dataset_id}/syncs/{sync_id}
동기화 상세
단일 동기화 실행의 진행률·경고·오류 반환 (VIEW 권한).
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ | |
sync_id | path | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
DELETE /api/v1/datasets/{dataset_id}/syncs/{sync_id}
DELETE/api/v1/datasets/{dataset_id}/syncs/{sync_id}
동기화 기록 삭제
끝난 동기화 기록을 이력에서 삭제.
필요 권한: DATASET_WRITE
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ | |
sync_id | path | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 204 | Successful Response |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/datasets/{dataset_id}/syncs/{sync_id}:cancel
POST/api/v1/datasets/{dataset_id}/syncs/{sync_id}:cancel
동기화 취소
진행 중인 동기화 취소.
필요 권한: DATASET_WRITE
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
dataset_id | path | string | ✓ | |
sync_id | path | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |