수정¶
POST /api/v1/notice/date/{notice_date_uuid}/modify
개요¶
사용자 지정 알림 날짜 구성을 수정하고 날짜 집합을 전체 교체합니다.
호출 전 및 사용 단계¶
수정 시 name을 반드시 제출해야 하며, noticeDates는 전체 대상 집합으로 교체해야 합니다. noticeDates를 생략하면 기존 집합이 비워지므로, 기존 날짜를 유지하려면 먼저 상세 정보를 조회한 후 전체를 제출해야 합니다. 수정 시 현재 워크스페이스의 알림 정책 실행 캐시가 정리되며, 해당 날짜 집합을 사용하는 시간 윈도우는 이후 새 값으로 업데이트됩니다. 구성당 최대 366개 항목이며, 중복 날짜는 그대로 저장되고 개수 제한에 포함됩니다. 서버는 YYYY/MM/DD 텍스트 형식만 검증합니다. 2026/02/30과 같이 존재하지 않는 날짜도 저장될 수 있으므로 클라이언트에서 실제 달력을 기준으로 직접 검증해야 합니다. 이 리소스는 날짜 집합만 저장하며, 당일 시작 시각, 지속 시간 또는 시간대는 포함하지 않습니다. 사용 시 알림 정책 alertOpt.alertTarget[].customDateUUIDs에서 이 리소스의 UUID를 참조하고 customStartTime/customDuration을 함께 설정합니다. 구체적인 규칙은 알림 정책 파라미터 페이지를 참조하세요. 현재 알림 실행 시간대 읽기에는 알려진 제한이 있으므로 알림 정책 페이지 설명에 따라 실제 시간대를 확인해야 합니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notice_date_uuid | string | Y | 본 워크스페이스의 사용자 지정 알림 날짜 구성 UUID로, ndate_로 시작합니다. 날짜 문자열이나 알림 정책 UUID가 아닙니다. 빈 문자열 허용: False 예시: ndate_example가져오기 또는 입력 방법: 사용자 지정 알림 날짜 목록의 content.data[].uuid 또는 생성 응답 content.uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| noticeDates[*] | string | 단일 날짜 문자열, YYYY/MM/DD. 서버는 형식 정규식만 검사하며 윤년, 월별 일수 등을 완전히 검증하지 않으므로 저장 성공만으로 날짜가 실제로 유효하다고 판단할 수 없습니다. 예시: 2026/11/20가져오기 또는 입력 방법: 비즈니스 달력에서 네 자리 연도/두 자리 월/두 자리 일을 생성합니다(예: 2026/11/20). 클라이언트에서 실제 달력 유효성을 확인해야 합니다. |
|
| name | string | Y | 필수 이름이며 선언상 최대 256자입니다. 현재 저장 필드 용량이 더 짧으므로 저장 실패를 줄이려면 64자를 넘지 않도록 권장합니다. null 허용: False 최대 길이: 256 예시: 生产维护日가져오기 또는 입력 방법: 사용자 지정 알림 날짜 목록에서 본 워크스페이스의 기존 이름을 확인한 후 직접 이름을 지정합니다. |
| noticeDates | array | 선택적 전체 날짜 문자열 배열이며 최대 366개 항목입니다(중복 항목도 계산됨). 생성 시 생략하면 []가 저장됩니다. 수정 시 생략하거나 []를 전달하면 기존 날짜 집합이 비워집니다. null 허용: False 예시: ["2026/11/20", "2026/11/27"]가져오기 또는 입력 방법: 비즈니스 유지보수/알림 달력에 따라 실제 날짜를 선택하고 YYYY/MM/DD 문자열로 입력합니다. 타임스탬프로 변환할 필요는 없습니다. |
파라미터 추가 설명¶
날짜 구성에서는 시간대, 시작 시각 또는 지속 시간(초)을 지정하지 않습니다. 이는 해당 구성을 참조하는 알림 정책 작업에서 제어합니다. 저장에 성공해도 알림이 즉시 전송되지는 않습니다. 요청이 실패하면 먼저 저장되었는지 조회한 후 재시도 여부를 결정합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notice/date/ndate_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产维护日","noticeDates":["2026/11/20","2026/11/27"]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 저장된 날짜 구성 레코드 번호이며, 작업에는 uuid를 사용합니다. |
| content.uuid | string | 날짜 구성 UUID로, 알림 정책 customDateUUIDs에서 참조할 수 있습니다. |
| content.workspaceUUID | string | 소속 워크스페이스 UUID입니다. |
| content.name | string | 구성 이름입니다. |
| content.dates | array<string> |
저장된 날짜 배열입니다. 요청 필드명은 noticeDates이고 응답 필드명은 dates입니다. |
| content.dates[] | string | 단일 YYYY/MM/DD 날짜 문자열입니다. |
| content.status | integer | 레코드 상태이며 0은 정상, 3은 삭제됨입니다. |
| content.creator | string | 생성 주체입니다. |
| content.updator | string | 최근 업데이트 주체이며, 아직 업데이트되지 않은 경우 빈 문자열입니다. |
| content.createAt | integer | 생성 시간, Unix 초입니다. |
| content.updateAt | integer | 업데이트 시간, Unix 초이며 아직 업데이트되지 않은 경우 -1입니다. |
| content.deleteAt | integer | 삭제 시간, Unix 초이며 삭제되지 않은 경우 -1입니다. |
| content.declaration | object 또는 null | 워크스페이스 공통 선언입니다. |
{
"code": 200,
"content": {
"id": 42,
"uuid": "ndate_example",
"workspaceUUID": "wksp_example",
"name": "生产维护日",
"dates": [
"2026/11/20",
"2026/11/27"
],
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785430800,
"updateAt": 1785430860,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 날짜 구성이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 속하지 않음 | 지정한 객체가 존재하지 않음 | 사용자 지정 알림 날짜 목록에서 유효한 uuid를 다시 가져옵니다. |
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드 이름, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 단일 JSON 객체를 제출합니다. |
| 400 | ft.NoticeDateNameRepeat | 현재 워크스페이스에 동일한 이름의 삭제되지 않은 날짜 구성이 존재함 | 사용자 지정 날짜 구성 이름 중복 | 다른 이름을 선택합니다. 타임아웃 후에는 먼저 이미 생성되었는지 확인합니다. |
| 400 | ft.InvalidNoticeDate | noticeDates의 날짜 문자열 형식이 YYYY/MM/DD에 맞지 않음 | 유효하지 않은 날짜 형식 | 네 자리 연도, 두 자리 월/일과 영문 슬래시를 사용하고 달력 유효성을 직접 확인합니다. |
| 406 | ft.CountExceedLimit | noticeDates 배열이 366개 항목을 초과함 | {} 개수가 {} 최대 제한을 초과함 | 각 구성을 366개 항목 이내로 제한하고, 불필요한 중복 날짜를 먼저 제거합니다. |
| 500 | ft.InternalServerError | 날짜 배열 요소가 문자열이 아니거나 저장/캐시 처리 등 내부 오류 발생 | 내부 오류 | 파라미터 표에 따라 유형과 이름 길이를 수정하고, 현재 저장된 구성을 먼저 확인한 후 재시도 여부를 결정합니다. 지속적으로 실패하면 traceId를 제공합니다. |