삭제¶
POST /api/v1/notify_object/delete
개요¶
워크스페이스 알림 대상을 삭제합니다.
호출 전 및 사용 단계¶
먼저 알림 대상 목록에서 UUID를 확인하고, 해당 대상을 참조하는 알림 정책 또는 알림 전략을 조정하세요. 이 작업은 현재 워크스페이스에서 일치하는 대상을 소프트 삭제하고 알림 정책 캐시를 정리합니다. 모든 참조가 자동으로 해제됨을 보장하지는 않습니다. 일치하는 대상이 없어도 true를 반환하며, 반복 호출해도 대상이 존재하지 않는다는 오류가 발생하지 않습니다. 일괄 요청에서 어느 하나의 대상에 대한 작업 권한이 없으면 실패합니다. 서비스 오류가 발생한 후에는 먼저 결과를 다시 조회한 뒤 재시도하세요.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notifyObjectUUID | string | Y | 삭제할 단일 알림 대상 UUID입니다. null 허용: False 예시: notify_example획득 또는 입력 방법: 알림 대상 목록에서 반환된 content.data[].uuid에서 현재 워크스페이스의 알림 대상 UUID를 복사합니다. |
파라미터 추가 설명¶
현재 워크스페이스 내에서 삭제되지 않은 대상만 처리됩니다. 반환값은 삭제 수량을 제공하지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notify_object/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"notifyObjectUUID":"notify_example"}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 삭제 처리가 완료되면 true이며, 일치하는 대상이 없는 경우도 포함합니다. |
{
"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을 수정하세요. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 단일 JSON 객체를 제출하세요. |
| 403 | ft.ForbiddenNotifyObjOperation | 대상이 사용자 지정 권한을 활성화했으며 현재 ID가 작업 가능 범위에 없음 | 알림 대상【{}】에 대한 작업 권한이 없습니다 | 관리 권한이 있는 ID로 대상의 permissionSet 및 워크스페이스 고급 권한 설정을 확인하세요. |
| 500 | ft.InternalServerError | 삭제 제출, 캐시 정리 또는 후속 감사 실패 | 내부 오류 | 먼저 목록을 조회하여 대상이 여전히 존재하는지 확인하고, 500을 '삭제되지 않음'으로 간주하지 않도록 한 뒤 traceId를 포함하여 재시도하거나 지원팀에 문의하세요. |