콘텐츠로 이동

일정 생성¶

POST /api/v1/notification_schedule/add

개요¶

일정 생성

Body 요청 매개변수¶

매개변수명	유형	필수	설명
name	string	Y	이름 빈 값 허용 안 함: False 최대 길이: 256 빈 문자열 허용 안 함: False
timezone	string		시간대, 기본값 Asia/Shanghai 예: Asia/Shanghai 빈 값 허용 안 함: False 최대 길이: 48
start	string	Y	시간 범위 시작 시간 예: 00:00 빈 값 허용 안 함: False 최대 길이: 48
end	string	Y	시간 범위 종료 시간 예: 23:59 빈 값 허용 안 함: False 최대 길이: 48
notifyTargets	array	Y	알림 대상, 계정 uuid, 알림 대상 uuid, 이메일 포함 예: ['acnt_xxx', 'notify_', 'xxx@guance.com'] 빈 값 허용 안 함: False
extend	json		확장 정보, 교대 알림 대상 구성 포함 빈 값 허용 안 함: False
extend.enableRotateNotification	boolean		교대 활성화 여부, 기본값 비활성화 예: False 빈 값 허용 안 함: False
extend.rotationCycle	string		교대 주기, 일: day, 주: week, 월: month, 평일: workDay, 주말: weekend 예: day 빈 값 허용 안 함: False 선택 가능 값: ['day', 'week', 'month', 'workDay', 'weekend']
extend.effectiveTime	json		일정 유효 기간, 기본값 영구 유효, 시작/종료 시간은 11자리 타임스탬프 예: {'start': 1719990196, 'end': 1729990196} 빈 값 허용 안 함: False

매개변수 추가 설명¶

1. 요청 매개변수 설명

매개변수명	유형	필수	설명
name	String	필수	일정 이름
start	String	필수	시간 범위 시작 시간
end	String	필수	시간 범위 종료 시간
timezone	String		시간대
notifyTargets	array	필수	알림 대상, 계정 uuid, 알림 대상 uuid, 이메일 포함
extend	Json		확장 정보

2. extend 내 매개변수 설명

매개변수명	유형	필수	설명
enableRotateNotification	Boolean		알림 대상 교대 활성화 여부, 기본값 비활성화
rotationCycle	string		알림 대상 교대 활성화 시 교대 주기
effectiveTime	json		일정 유효 시간 구성, 기본값 영구 유효, 시작/종료 시간은 11자리 타임스탬프

요청 예제¶

curl 'https://openapi.guance.com/api/v1/notification_schedule/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"schecule_add","timezone":"Asia/Shanghai","start":"00:00","end":"23:59","notifyTargets":["acnt_8b4bd2b8782646f3ba8f6554193f5997","notify_1c08db8458ba4ecabd27b8ce805e8502"],"extend":{"enableRotateNotification":true,"rotationCycle":"workDay","effectiveTime":{"start":1735747200,"end":1737603472}}}' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "createAt": 1735797896,
        "creator": "wsak_f2ba9858f4414655be39efc882b120dd",
        "declaration": {},
        "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": true,
            "rotationCycle": "workDay"
        },
        "id": null,
        "name": "schecule_add",
        "notifyTargets": [
            "acnt_8b4bd2b8782646f3ba8f6554193f5997",
            "notify_1c08db8458ba4ecabd27b8ce805e8502"
        ],
        "rotationUpdateAt": 1735797896,
        "start": "00:00",
        "status": 0,
        "timezone": "Asia/Shanghai",
        "updateAt": null,
        "updator": null,
        "uuid": "nsche_3512c1f4d176433484676225b547ef7a",
        "workspaceUUID": "wksp_798c5e0f589e4992994196832f64b6ba"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-2655C615-0DA5-4391-8528-E46D1783B3F6"
}