콘텐츠로 이동

목록 조회



GET /api/v1/notice/date/list

개요

현재 워크스페이스의 사용자 지정 알림 날짜 구성을 페이지 단위로 조회합니다.

호출 전 및 사용 단계

기본값은 pageIndex=1, pageSize=20이며, 레코드 번호 기준 내림차순으로 정렬됩니다. content.data 배열과 최상위 pageInfo를 읽고, 알림 정책에서 참조할 수 있도록 uuid를 저장합니다. 응답에서 날짜 필드의 이름은 dates입니다. 이 리소스는 날짜 집합만 저장하며, 당일 시작 시각, 지속 시간, 시간대는 포함하지 않습니다. 사용 시 알림 정책의 alertOpt.alertTarget[].customDateUUIDs에서 이 리소스의 UUID를 참조하고 customStartTime/customDuration을 함께 설정합니다. 구체적인 규칙은 알림 정책 파라미터 페이지를 참조하세요. 현재 알림 실행 시간대 읽기에는 알려진 제한이 있으므로, 알림 정책 페이지의 설명에 따라 실제 시간대를 확인해야 합니다.

요청 헤더

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

Query 요청 파라미터

파라미터 이름 타입 필수 설명
pageIndex integer 페이지 번호, 기본값 1, 최솟값 1.
null 허용: False
$minValue: 1
예: 1
획득 또는 입력 방법: 1부터 페이지마다 증가시키고 검색 조건은 변경하지 않습니다.
pageSize integer 페이지당 항목 수, 기본값 20, 최댓값 10000.
null 허용: False
$maxValue: 10000
$minValue: 1
예: 20
획득 또는 입력 방법: 필요에 따라 1~10000 사이로 입력하며, 응답 크기를 제어하려면 적절한 페이지 크기를 사용하는 것이 좋습니다.
search string 선택적 이름 부분 일치 검색입니다.
null 허용: True
예: 维护
획득 또는 입력 방법: 날짜 구성 이름의 일부 텍스트를 입력합니다. 생략하거나 공백으로 두면 필터링하지 않습니다.

파라미터 추가 설명

날짜 집합 자체는 알림을 트리거하지 않으며, 알림 정책 생성 v2에서 대상과 사용자 지정 날짜 기간을 구성해야 합니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/notice/date/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=20

응답

HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 타입 설명
content.data array<object> 현재 페이지 구성이며, 결과가 없으면 []입니다.
content.data[].id integer 저장된 날짜 구성 레코드 번호이며, 작업에는 uuid를 사용합니다.
content.data[].uuid string 날짜 구성 UUID이며, 알림 정책의 customDateUUIDs에서 참조합니다.
content.data[].workspaceUUID string 소속 워크스페이스 UUID입니다.
content.data[].name string 구성 이름입니다.
content.data[].dates array<string> 저장된 날짜 배열입니다. 요청 필드 이름은 noticeDates이고, 응답 필드 이름은 dates입니다.
content.data[].dates[] string 단일 YYYY/MM/DD 날짜 문자열입니다.
content.data[].status integer 레코드 상태입니다(0: 정상, 3: 삭제됨).
content.data[].creator string 생성 주체입니다.
content.data[].updator string 최근 업데이트 주체이며, 아직 업데이트되지 않은 경우 빈 문자열입니다.
content.data[].createAt integer 생성 시간(Unix 초)입니다.
content.data[].updateAt integer 업데이트 시간(Unix 초)이며, 아직 업데이트되지 않은 경우 -1입니다.
content.data[].deleteAt integer 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다.
content.declaration object 또는 null 워크스페이스 공통 선언입니다.
pageInfo object 최상위 페이지네이션입니다.
pageInfo.pageIndex integer 페이지 번호입니다.
pageInfo.pageSize integer 페이지 크기입니다.
pageInfo.count integer 현재 페이지의 실제 항목 수입니다.
pageInfo.totalCount integer 일치하는 구성의 총 개수입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 42,
        "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",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "count": 1,
    "totalCount": 1
  }
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다. 파라미터 파싱 실패 파라미터 위치, 필드 이름, 타입, 값을 확인하세요.
500 ft.InternalServerError 날짜 구성 읽기 실패 내부 오류 잠시 후 다시 시도하고, 계속 실패하면 traceId를 제공하세요.

문서 평가

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