삭제¶
POST /api/v1/notification_schedule/delete
개요¶
현재 워크스페이스의 알림 일정과 일정 이력을 일괄 소프트 삭제합니다.
호출 전 및 사용 단계¶
먼저 일정 목록에서 삭제할 UUID를 확인하고, 삭제 전에 알림 정책 목록의 참조를 조정하여 삭제된 일정에 대한 의존을 피하세요. 명확한 UUID 문자열 배열을 전달하세요. 빈 배열이거나 일치하는 레코드가 없는 경우에도 여전히 true를 반환할 수 있습니다. 성공하면 당일 온콜 캐시가 정리됩니다. 반복 호출이 곧 사용 가능한 일정이 남아 있음을 의미하지는 않습니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notificationScheduleUUIDs[*] | string | 단일 일정 UUID 문자열입니다. 예시: nsche_example가져오기 또는 입력 방법: 일정 목록에서 단일 uuid를 복사합니다. |
|
| notificationScheduleUUIDs | array | Y | 삭제할 UUID 배열이며 현재 워크스페이스에만 적용됩니다. null 허용: False 예시: ["nsche_example"]가져오기 또는 입력 방법: 일정 목록의 content.data[].uuid에서 삭제할 일정을 선택합니다. |
파라미터 추가 설명¶
true 반환만으로 전달한 모든 UUID가 원래 존재했다고 판단할 수 없습니다. 삭제는 알림 정책의 자동 연결 해제를 보장하지 않으므로, 참조를 미리 확인하세요.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notification_schedule/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"notificationScheduleUUIDs":["nsche_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 객체를 제출합니다. |
| 500 | ft.InternalServerError | 삭제 처리, 이력 설정 읽기, 온콜 캐시 정리 또는 감사 중 예외 발생 | 내부 오류 | 먼저 목록에서 대상 일정이 여전히 존재하는지 확인한 후 재시도를 결정합니다. traceId와 대상 UUID를 보관합니다. |