삭제¶
GET /api/v1/notes/{notes_uuid}/delete
개요¶
기존 GET 라우트를 통해 지정된 레거시 노트를 삭제합니다.
호출 전 확인 및 사용 단계¶
먼저 노트 상세에서 삭제할 노트를 확인하고, 필요에 따라 노트 내보내기로 템플릿을 저장합니다. 삭제 시 노트 순서 목록에서 참조하는 차트도 소프트 삭제됩니다. 호출 주체는 시나리오 관리 권한을 보유하거나 노트 생성 주체여야 합니다. 이 URL은 상태를 기록하므로 삭제를 확정한 후 클라이언트가 직접 호출해야 하며, 미리보기나 폴링에 사용해서는 안 됩니다.
라우트 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| notes_uuid | string | Y | 대상 레거시 노트의 UUID입니다. 예시: note_example가져오기 또는 입력 방법: 노트 목록의 content.data[].uuid에서 가져오거나, 생성 응답의 content.uuid를 사용할 수도 있습니다. |
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
이는 하위 호환성을 위한 GET 삭제 인터페이스입니다. 타임아웃 발생 시 먼저 노트가 목록에 여전히 있는지 확인한 후 다음 단계를 처리합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/notes/note_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content.noteName | string | 삭제된 노트의 이름입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"noteName": "生产巡检笔记",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.NotFoundNote | UUID가 이미 삭제되었거나, 존재하지 않거나, 현재 API Key의 워크스페이스에 속하지 않음 | 지정된 노트를 찾을 수 없습니다 | 동일한 워크스페이스의 노트 목록으로 UUID를 확인합니다. |
| 403 | ft.Forbidden | 호출 주체가 시나리오 관리 권한도 없고 노트 생성 주체도 아님 | 작업 권한이 없습니다 | 노트 생성 시 사용한 Key 또는 시나리오 관리 권한이 있는 호출 주체로 변경합니다. |