조회¶
GET /api/v1/notice/date/{notice_date_uuid}/get
개요¶
날짜 설정 하나의 이름과 전체 날짜 집합을 조회합니다.
호출 전 및 사용 단계¶
사용자 정의 알림 날짜 목록에서 uuid를 가져온 후 호출합니다. content.dates를 수정 시의 전체 대상 배열로 읽고, 응답 필드 dates를 요청 매개변수로 직접 사용하지 마십시오. 요청에는 반드시 noticeDates를 사용해야 합니다. 이 리소스는 날짜 집합만 저장하며, 당일 시작 시각, 지속 시간 또는 시간대는 포함하지 않습니다. 사용 시 알림 정책의 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를 가져옵니다. |
매개변수 추가 설명¶
이 API는 저장된 날짜를 조회하며, 기존 값에 대해 실제 달력 유효성을 다시 검증하지 않습니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/notice/date/ndate_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
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": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 날짜 설정이 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 속하지 않음 | 지정된 객체가 존재하지 않습니다. | 사용자 정의 알림 날짜 목록에서 유효한 uuid를 다시 가져오십시오. |
| 500 | ft.InternalServerError | 날짜 설정 조회 실패 | 내부 오류 | 잠시 후 다시 시도하고, 계속 실패하면 traceId를 제공하십시오. |