콘텐츠로 이동

첨부 파일 삭제



POST /api/v1/attachment/delete

개요

현재 워크스페이스의 첨부 파일을 삭제 상태로 표시합니다. 삭제 후 해당 식별자로는 첨부 파일 다운로드 API를 통해 파일을 더 이상 가져올 수 없습니다.

호출 전 및 사용 단계

  1. 첨부 파일 업로드 성공 응답의 content.attachmentUuid에서 값을 가져옵니다.
  2. 첨부 파일 관리 권한이 있는 워크스페이스 API Key를 사용합니다. 해당 첨부 파일이 더 이상 필요하지 않은지 확인한 후 예시에 따라 JSON을 전송합니다.
  3. 이미 삭제되었거나 현재 워크스페이스에 일치하는 레코드가 없어도 true를 반환하며, 동일한 식별자를 반복 전송해도 새 레코드가 생성되지 않습니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y AK 식별자, AK uuid
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 본 API 권한을 가진 Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 유형 필수 설명
attachmentUUID string Y 첨부 파일 UUID
null 허용: False
예: att_00000000000000000000000000000000
가져오기 또는 입력 방법: 첨부 파일 업로드 성공 응답의 content.attachmentUuid에서 값을 가져옵니다.

요청 예시

curl 'https://openapi.guance.com/api/v1/attachment/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"attachmentUUID":"att_00000000000000000000000000000000"}'

응답

HTTP 200, application/json.

필드 유형 설명
content boolean 처리가 완료되면 true이며, 현재 워크스페이스에 일치하는 레코드가 없는 경우도 포함합니다.
{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed JSON 객체에 필수 첨부 파일 식별자가 누락되었거나 유형이 일치하지 않음 메시지에서 attachmentUUID 또는 해당 검증 규칙을 지적합니다. 필드 이름 대소문자를 확인하고 문자열을 전달합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문 오류 요청 JSON 형식 오류입니다. reason, line, column을 반환합니다. 위치에 따라 JSON을 수정합니다.

문서 평가

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