콘텐츠로 이동

삭제



POST /api/v1/objc_cfg/delete

개요

지정한 사용자 정의 객체 분류의 다운스트림 데이터를 삭제합니다.

호출 전 및 사용 단계

이 API를 사용하려면 API Key에 infrastructure.setManage 권한이 있어야 합니다.

실제 호출은 POST /objc_cfg/delete이며, Body의 sourceType은 반드시 custom_object여야 합니다. 컨트롤러가 해당 유형을 고정하며 시스템 object 삭제는 지원하지 않습니다. objc_name에는 구성 uuid/표시 별칭이 아닌 실제 분류명을 사용합니다.

이 공개 구현은 해당 custom_object 분류 데이터의 다운스트림 삭제만 요청하며, 로컬 ObjcCfg를 소프트 삭제하거나 메뉴를 정리하거나 사이트 템플릿을 삭제하는 로직은 없습니다. true를 카탈로그 표시 구성도 제거된 것으로 해석해서는 안 되며, 실제 삭제 수량도 반환하지 않습니다. 데이터 삭제는 복구할 수 없으므로 먼저 백업과 수집 측의 후속 보고 동작을 확인해야 합니다. 계속 보고하면 분류가 다시 나타날 수 있습니다.

다운스트림 삭제가 성공하면 true를 반환합니다. 타임아웃/500 발생 시 먼저 실제 데이터를 확인해야 하며, 삭제가 발생하지 않았다고 단정하거나 무작정 반복해서는 안 됩니다.

요청 헤더

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

Body 요청 파라미터

파라미터 이름 유형 필수 설명
objc_name string Y 삭제 Body 필수입니다. 경로 내보내기/수정에도 동일한 분류명을 사용하며, 이름은 보고되는 class와 일치해야 하고 경로는 URL 인코딩해야 합니다. 별칭은 표시만 제어하며 대상 이름으로 사용하지 않습니다.
null 허용: False
예: example_resources
얻거나 입력하는 방법: 리소스 카탈로그 목록content[].name에서 분류 코드를 가져오며, objc_ 구성 UUID 또는 alias가 아닙니다.
sourceType string Y 공개 API에서 필수이며 object/custom_object만 지원합니다. 공유 내부 함수의 *_history는 지원하지 않습니다. 생성 시 실제로는 templateInfo.main[0].class를 사용하므로 반드시 이 필드와 일치해야 합니다. 수정/읽기에서는 구성 유형을 선택하는 데 사용합니다. 삭제 공개 API에서는 custom_object만 지원하며 컨트롤러가 이 유형을 고정합니다.
null 허용: False
선택 가능한 값: ['custom_object']
예: custom_object
얻거나 입력하는 방법: 시스템 객체는 object, 사용자 정의 리소스 객체는 custom_object를 선택하며 실제 보고 데이터 소스를 사용합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/objc_cfg/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"sourceType":"custom_object","objc_name":"example_resources"}'

응답

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

필드 유형 설명
content boolean 호출 처리 성공 시 true이며, 삭제 수량/항목별 결과가 아닙니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

현재 API Key 워크스페이스의 구성만 수정/내보내기할 수 있습니다. 목록은 권한이 부여된 대상 워크스페이스에 대해 집계할 수 있지만, 그 표시 구성은 여전히 현재 워크스페이스 기준입니다. 인터페이스에는 freeEdition 버전 선언이 있으나, 공통 OpenAPI 인증은 이 route에서 해당 버전 검사를 수행하지 않으므로 버전 자체를 고정 403으로 작성하지 않습니다. 업스트림 조회 4xx는 실제 Kodo/권한 매핑에 따르며, 일반 5xx는 최종적으로 500 ft.InternalServerError가 됩니다.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드 누락 또는 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
400 ft.JsonFormatError Body 최상위가 JSON 객체가 아님 일부 json 파일 형식 오류 이 페이지의 필드를 포함하는 객체를 제출합니다.
500 ft.InternalServerError 다운스트림 삭제 실패/타임아웃 또는 반환 처리에서 포착되지 않은 예외 발생 내부 오류 분류명으로 데이터의 실제 상태를 확인하고 traceId를 보존합니다. 이 인터페이스는 로컬 표시 구성을 정리하지 않으므로 목록에 항목이 남아 있다고 해서 데이터 삭제 실패로 판단하지 않습니다.

문서 평가

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