콘텐츠로 이동

삭제



POST /api/v1/notes_v2/{note_uuid}/delete

개요

지정된 새 버전 노트를 삭제합니다.

호출 전 및 사용 단계

새 버전 노트 상세로 대상 UUID를 확인하고, 필요한 경우 먼저 본문 백업을 저장하세요. 읽어온 etag를 ifMatch로 전달하는 것이 좋습니다. 호출은 노트 본문을 삭제하고, 레코드를 삭제됨으로 표시하며 즐겨찾기를 정리합니다. 비공개 노트는 생성 주체가 삭제합니다. 활성 상태 페이지와 연결된 경우 상태 페이지 구성 권한도 필요합니다. 요청 시간 초과 시 먼저 상세 또는 목록에서 확인하세요.

라우트 파라미터

파라미터 이름 유형 필수 설명
note_uuid string Y 새 버전 노트 UUID입니다.
예: nbnote_example
가져오기 또는 입력 방법: 새 버전 노트 목록의 content.data[].noteUUID 또는 생성 결과의 content.noteUUID에서 복사합니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 유형 필수 설명
ifMatch string 선택적 버전 검증입니다. 업데이트 또는 삭제 전에 이 버전을 비교하며, 생략하면 조건을 추가하지 않습니다.
null 허용: False
예: etag-example-1
가져오기 또는 입력 방법: 새 버전 노트 상세의 content.etag에서 가져와 그대로 전달합니다.

추가 파라미터 설명

동일한 UUID를 반복해서 삭제하면 이미 삭제된 레코드는 존재하지 않는 것으로 처리됩니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/notes_v2/nbnote_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ifMatch":"etag-example-1"}'

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.noteUUID string 삭제된 노트 UUID입니다.
content.noteName string 해당 노트의 삭제 전 이름입니다.
content.declaration object 또는 null 워크스페이스의 공통 선언입니다.
{
  "code": 200,
  "content": {
    "noteUUID": "nbnote_example",
    "noteName": "운영 점검 안내",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.

HTTP 424를 수신하면 content.upstreamStatus는 다운스트림이 반환한 상태이며, 연결 이상 시 0일 수 있습니다. content.upstreamPath는 해당 실패 요청의 경로이고, content.responseBody는 다운스트림 오류 내용입니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인하세요.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정하세요.
400 ft.JsonFormatError JSON 구문은 유효하지만 요청 최상위가 객체가 아님 일부 json 파일 형식 오류 파라미터를 JSON 객체에 넣으세요.
404 ft.NotFoundNote 활성 노트가 존재하지 않거나 현재 워크스페이스에 속하지 않거나 이미 삭제됨 지정된 노트를 찾을 수 없음 현재 워크스페이스, 대상 noteUUID 및 작업이 성공했는지 확인하세요.
403 ft.ForbiddenOperationResource 호출 주체가 다른 사용자의 비공개 노트를 수정하거나 삭제함, 또는 대상이 활성 상태 페이지와 연결되어 있고 statusPage.configManage가 누락됨 작업 권한 없음 대상의 가시 범위 및 상태 페이지 연결을 확인하고 필요한 권한을 갖춘 호출 주체로 전환하세요.
424 ft.NbookDBApiError 노트 서비스가 쓰기 또는 삭제를 거부하거나, 버전 조건이 일치하지 않거나, 요청이 실패함 노트 서비스 호출 실패 먼저 content.upstreamStatus를 확인하세요. 버전 충돌인 경우 새 버전 노트 상세로 본문과 ETag를 다시 읽고 병합한 후 새 ifMatch로 다시 제출하세요. 요청 시간 초과 시 먼저 대상 상태를 확인하세요.

문서 평가

이 페이지가 도움이 되었나요?