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