콘텐츠로 이동

목록¶

GET /api/v1/notification_schedule/list

개요¶

Query 요청 파라미터¶

파라미터명	유형	필수	설명
mySchedule	string		내 일정 보기, 기본 false: 모든 일정 보기 빈 값 허용: True 선택 가능 값: ['true', 'false']
scheduleCalendar	string		일정 캘린더, 기본 false: 일정 관리 보기 빈 값 허용: True 선택 가능 값: ['true', 'false']
scTimezone	string		일정 캘린더 조회 시 시간대, 기본 Asia/Shanghai 예시: Asia/Shanghai 빈 값 허용: False 최대 길이: 48
scDateRange	string		일정 캘린더 조회 시 날짜 범위, 기본 조회 당일만 예시: 2024/06/22~2024/07/06 빈 값 허용: False 빈 문자열 허용: False 최대 길이: 48
notificationScheduleUUIDs	commaArray		일정 UUID 필터링 빈 값 허용: False
issueNotificationPolicyUUIDs	commaArray		알림 정책 UUID 필터링 빈 값 허용: False
notifyTargets	commaArray		알림 대상 필터링, acnt_xxx,notify_yyy,xxx@guance.com 빈 값 허용: False
search	string		이름 검색 빈 값 허용: True
pageIndex	integer		페이지 번호 빈 값 허용: False 예시: 1 $minValue: 1
pageSize	integer		페이지당 반환 개수 빈 값 허용: False 예시: 10 $minValue: 1 $maxValue: 100

파라미터 추가 설명¶

요청 예시¶

curl 'https://openapi.guance.com/api/v1/notification_schedule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "data": [
            {
                "createAt": 1735798360,
                "creator": "acnt_8b4bd2b8782646f3ba8f6554193f5997",
                "deleteAt": -1,
                "effectiveTimeInfos": {
                    "expired": false,
                    "timeStr": ""
                },
                "end": "23:59",
                "extend": {
                    "enableRotateNotification": false,
                    "rotationCycle": "day"
                },
                "id": 132,
                "inEffectNotifyTargetsInfos": [
                    {
                        "name": "tempN",
                        "status": 0,
                        "type": "HTTPRequest",
                        "uuid": "notify_1c08db8458ba4ecabd27b8ce805e8502"
                    }
                ],
                "issueNotificationPolicyInfos": [],
                "name": "temp22",
                "notifyTargets": [
                    "notify_1c08db8458ba4ecabd27b8ce805e8502"
                ],
                "notifyTargetsInfos": [
                    {
                        "name": "tempN",
                        "status": 0,
                        "type": "HTTPRequest",
                        "uuid": "notify_1c08db8458ba4ecabd27b8ce805e8502"
                    }
                ],
                "rotationUpdateAt": 1735798360,
                "start": "00:00",
                "status": 0,
                "timezone": "Asia/Shanghai",
                "updateAt": -1,
                "updator": "",
                "uuid": "nsche_6c18b90a5900413f960114058fce4d4c",
                "workspaceUUID": "wksp_798c5e0f589e4992994196832f64b6ba"
            },
            {
                "createAt": 1735797896,
                "creator": "wsak_f2ba9858f4414655be39efc882b120dd",
                "deleteAt": -1,
                "effectiveTimeInfos": {
                    "expired": false,
                    "timeStr": "2025/01/02 00:00:00~2025/01/23 11:37:52"
                },
                "end": "23:59",
                "extend": {
                    "effectiveTime": {
                        "end": 1737603472,
                        "start": 1735747200
                    },
                    "enableRotateNotification": false
                },
                "id": 131,
                "inEffectNotifyTargetsInfos": [
                    {
                        "acntWsNickname": "",
                        "email": "xxx@guance.com",
                        "iconUrl": "",
                        "mobile": "17621725046",
                        "name": "jon",
                        "status": 0,
                        "username": "jon",
                        "uuid": "acnt_8b4bd2b8782646f3ba8f6554193f5997",
                        "wsAccountStatus": 0
                    }
                ],
                "issueNotificationPolicyInfos": [],
                "name": "schecule_modify",
                "notifyTargets": [
                    "acnt_8b4bd2b8782646f3ba8f6554193f5997"
                ],
                "notifyTargetsInfos": [
                    {
                        "acntWsNickname": "",
                        "email": "xxx@guance.com",
                        "iconUrl": "",
                        "mobile": "17621725046",
                        "name": "jon",
                        "status": 0,
                        "username": "jon",
                        "uuid": "acnt_8b4bd2b8782646f3ba8f6554193f5997",
                        "wsAccountStatus": 0
                    }
                ],
                "rotationUpdateAt": 1735798211,
                "start": "11:00",
                "status": 0,
                "timezone": "Asia/Shanghai",
                "updateAt": 1735798211,
                "updator": "wsak_f2ba9858f4414655be39efc882b120dd",
                "uuid": "nsche_3512c1f4d176433484676225b547ef7a",
                "workspaceUUID": "wksp_798c5e0f589e4992994196832f64b6ba"
            }
        ],
        "declaration": {},
        "myScheduleCount": 0,
        "totalScheduleCount": 2
    },
    "errorCode": "",
    "message": "",
    "pageInfo": {
        "count": 2,
        "pageIndex": 1,
        "pageSize": 10,
        "totalCount": 2
    },
    "success": true,
    "traceId": "TRACE-0D517EFF-5D02-4672-9189-1C9DEB248E23"
}