삭제¶
POST /api/v1/issue/notification_policy/delete
개요¶
알림 정책을 일괄 삭제하고 연결된 채널, 일정 관계 및 에스컬레이션 트리거 구성을 정리합니다.
호출 전 및 사용 단계¶
알림 정책 목록에서 삭제할 정책 uuid를 가져오고, 채널이 더 이상 이러한 정책에 의존하지 않는지 확인한 후 배열을 제출합니다. 이 작업은 정책 구성과 관계를 삭제하며, 일정, 채널, Issue 또는 알림 대상 자체는 삭제하지 않습니다. 일치하는 레코드가 없거나 빈 배열이어도 true를 반환할 수 있으며, 항목별 삭제 결과는 제공하지 않습니다. 삭제 후 후속 알림은 더 이상 해당 정책을 사용하지 않지만, 이미 제출된 비동기 작업이나 기존 메시지의 철회는 보장되지 않습니다. 정책 본문, 연결 관계 및 에스컬레이션 트리거 구성은 단계별로 저장됩니다. 실패 또는 타임아웃 후에는 먼저 상세 정보를 조회하여 기존 변경 사항을 확인한 뒤 재시도 여부를 결정합니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| issueNotificationPolicyUUIDs[*] | string | 단일 알림 정책 UUID입니다. 예시: inpy_example가져오기 또는 입력 방법: 알림 정책 목록에서 단일 uuid를 복사합니다. |
|
| issueNotificationPolicyUUIDs | array | Y | 삭제할 정책 UUID 배열, 필수; []는 정책을 삭제하지 않습니다. null 허용: False 예시: ["inpy_example"]가져오기 또는 입력 방법: 알림 정책 목록의 content.data[].uuid에서 같은 워크스페이스의 정책 UUID를 가져옵니다. |
파라미터 추가 설명¶
일괄 요청은 현재 워크스페이스 내 일치하는 정책만 조작합니다. 일시적으로 비활성화해야 하는 경우 콘솔에서 조작할 수 있으며, 이 5개 공개 API는 개별 활성화/비활성화 메서드를 제공하지 않습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/issue/notification_policy/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"issueNotificationPolicyUUIDs":["inpy_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 삭제 처리가 완료되면 true이며, 일치하는 정책이 없을 때도 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를 제공하십시오. |