콘텐츠로 이동

생성



POST /api/v1/notice/date/add

개요

알림 정책에서 참조하는 사용자 정의 알림 날짜 집합을 생성합니다.

호출 전 및 사용 단계

name과 선택적 noticeDates를 제출하여 날짜 집합을 생성합니다. 배열을 생략하거나 []로 지정하면 빈 집합을 생성할 수 있으며, 실제 알림이 필요하면 먼저 유효한 업무 날짜를 준비해야 합니다. 각 설정은 최대 366개 항목이며, 중복 날짜는 그대로 저장되고 개수 제한에도 포함됩니다. 서버는 YYYY/MM/DD 텍스트 형식만 검증하며, 2026/02/30처럼 존재하지 않는 날짜도 저장될 수 있으므로 클라이언트에서 실제 달력을 기준으로 반드시 검증해야 합니다. 이 리소스는 날짜 집합만 저장하며, 당일 시작 시각, 지속 시간 또는 시간대는 포함하지 않습니다. 사용 시 알림 정책 alertOpt.alertTarget[].customDateUUIDs에서 이 리소스의 UUID를 참조하고 customStartTime/customDuration을 함께 설정하며, 구체적인 규칙은 알림 정책 파라미터 페이지를 참고하세요. 현재 알림 실행 시간대 조회에는 알려진 제한이 있으므로 알림 정책 페이지 설명에 따라 실제 시간대를 확인해야 합니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받습니다.

Body 요청 파라미터

파라미터명 유형 필수 설명
noticeDates[*] string 단일 날짜 문자열, YYYY/MM/DD. 서버는 형식 정규식만 검사하며 윤년, 월별 일수 등을 완전히 검증하지 않으므로 저장 성공만으로 날짜가 실제로 유효하다고 판단할 수 없습니다.
예시: 2026/11/20
획득 또는 입력 방법: 업무 달력에서 4자리 연도/2자리 월/2자리 일로 생성합니다(예: 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/add' \
  -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 또는 null 기록 번호로, 생성 응답이 저장 전에 구성되는 경우 null일 수 있으며 작업에는 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": null,
    "uuid": "ndate_example",
    "workspaceUUID": "wksp_example",
    "name": "프로덕션 유지보수일",
    "dates": [
      "2026/11/20",
      "2026/11/27"
    ],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785430800,
    "updateAt": -1,
    "deleteAt": -1,
    "declaration": {}
  },
  "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 객체를 제출합니다.
400 ft.NoticeDateNameRepeat 현재 워크스페이스에 동일한 이름의 삭제되지 않은 날짜 설정이 존재 사용자 정의 날짜 설정 이름 중복 다른 이름을 선택합니다. 타임아웃 발생 시 먼저 생성되었는지 확인합니다.
400 ft.InvalidNoticeDate noticeDates의 날짜 문자열 형식이 YYYY/MM/DD에 부합하지 않음 유효하지 않은 날짜 형식 4자리 연도, 2자리 월/일과 영문 슬래시를 사용하고 달력 유효성을 직접 확인합니다.
406 ft.CountExceedLimit noticeDates 배열이 366개 항목 초과 {} 개수가 {} 최대 제한을 초과 각 설정을 366개 항목 이내로 유지하고 불필요한 중복 날짜를 먼저 제거합니다.
500 ft.InternalServerError 날짜 배열 요소가 문자열이 아니거나 저장/캐시 처리 등 내부 실패 내부 오류 파라미터 표에 따라 유형과 이름 길이를 수정하고, 현재 저장된 설정을 먼저 확인한 후 재시도 여부를 결정하며 지속적으로 실패하면 traceId를 제공합니다.

문서 평가

이 페이지가 도움이 되었나요?