콘텐츠로 이동

삭제



POST /api/v1/dashboard/carousel/{carousel_uuid}/delete

개요

현재 호출 주체의 캐러셀 설정 한 건을 삭제합니다.

호출 전 및 사용 단계

캐러셀 목록에서 대상 캐러셀 및 UUID를 확인한 후 POST를 전송합니다. 이 작업은 캐러셀 설정을 삭제하며, 설정에서 참조하는 대시보드는 계속 사용할 수 있습니다. 요청 시간이 초과된 경우 먼저 목록을 조회하여 설정 상태를 확인합니다.

경로 매개변수

매개변수 이름 유형 필수 설명
carousel_uuid string Y 캐러셀 설정 UUID입니다.
예: csel_example
획득 또는 입력 방법: 동일한 워크스페이스와 호출 주체에서 캐러셀 목록의 content[].uuid에서 복사하거나, 생성 응답의 content.uuid를 사용할 수도 있습니다.

요청 헤더

매개변수 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/dashboard/carousel/csel_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content boolean 삭제 성공 시 true입니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
404 ft.DashboardCarouselObjectNotExist 설정이 삭제되었거나 존재하지 않거나 현재 호출 주체 및 워크스페이스에 속하지 않음 해당 캐러셀 객체가 존재하지 않습니다 동일한 Key로 캐러셀 목록에서 설정이 여전히 존재하는지 확인한 후 실제 UUID를 사용합니다.

문서 평가

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