콘텐츠로 이동

삭제



POST /api/v1/field_cfg/delete

개요

현재 워크스페이스의 사용자 정의 필드 구성을 일괄 소프트 삭제합니다.

호출 전 및 사용 단계

대상 워크스페이스의 API Key를 사용합니다. 이 구성은 기존 필드에 표시 별칭, 설명, 단위 및 분류를 추가하며, 수집 필드를 생성하거나 실제 데이터 유형을 변경하거나 과거 데이터를 백필하지 않습니다. 필드 출처가 같고 이름의 대소문자가 완전히 동일한 사용자 정의 구성은 중복될 수 없으며, 출처가 다르면 동일한 이름을 사용할 수 있습니다.

사용자 정의 구성 UUID 배열을 제출합니다. 현재 워크스페이스에서 sysField=0이고 삭제되지 않은 레코드만 삭제하며, 내장, 외부 워크스페이스, 찾을 수 없거나 이미 삭제된 UUID는 무시됩니다. true를 반환하며 일치/삭제 건수는 포함하지 않습니다. []도 성공할 수 있습니다. 삭제 후 목록에는 이전에 동일한 출처의 동일한 이름 사용자 정의 구성으로 가려졌던 내장 필드가 다시 표시됩니다. 실제 수집 데이터는 삭제되지 않습니다. 제출 후 캐시 정리에 실패하면 500이 반환될 수 있으므로 다시 읽어 확인한 후 재시도해야 합니다. 확인 후 반복 삭제는 일반적으로 아무 작업도 하지 않는 성공으로 처리됩니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
objUUIDs[*] string 삭제할 단일 UUID, 알 수 없음/외부 워크스페이스/내장은 삭제하지 않습니다.
예: field_example
획득 또는 입력 방법: 대상 사용자 정의 구성 UUID를 항목별로 입력합니다.
objUUIDs array Y 필수 배열, 각 항목은 비어 있지 않은 UUID 문자열을 권장하며 서버는 요소 유형을 완전히 검증하지 않습니다.
null 허용: False
예: ["field_example"]
획득 또는 입력 방법: 필드 목록에서 sysField=0인 레코드의 uuid 배열을 선택합니다.

파라미터 추가 설명

필드 표시 구성만 삭제하며 실제 데이터 및 내장 구성은 유지됩니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/field_cfg/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"objUUIDs":["field_example"]}'

응답

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

필드 유형 설명
content boolean 처리가 완료되면 true를 반환하며, 모든 요청 UUID가 삭제되었음을 의미하지는 않습니다.
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드명, 유형 및 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
500 ft.InternalServerError 쓰기, 제출 후 캐시 정리 또는 응답 조립 실패 내부 오류 먼저 목록/상세에서 제출된 상태를 확인한 후 재시도 여부를 결정하여 중복 생성을 방지합니다.

문서 평가

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