Cube Rewards Tool
#43b68
Back

前往 ClickUp
2025/12/05
8 min read

派獎 - 審核列表

派獎 - 審核列表.md
197 additions, 0 deletions
... ... @@ -1 +1,198 @@
1 +### SUMMARY
2 +取得派獎設定審核列表，包含待審核、已通過、已拒絕的審核紀錄。
3 +### REFERENCE TABLE
4 +* `DBMT.CMS_AUDIT`
5 +* `DBMT.CMS_AUDIT_ENTRY`
6 +* `DBMT.AWARD_GROUP`
7 +* `DBMT.AWARD`
8 +* `DBMT.AWARD_GP`
9 +
10 +### ATTRIBUTES
11 +* METHOD: **GET**
12 +* PATH: `/api/features/award/groups/audit`
13 +* LOGIN REQUIRED: **TRUE**
14 +* FEATURE: `AWARD_GROUP`
15 +* PERMISSION: `READ`, `APPLY`, `REVIEW`
16 +* CRYPTO: **None**
17 +
18 +### REQUEST
19 +#### HEADERS
20 +
21 +| Name | Type/Len | Required(*) | Desc |
22 +| ---| ---| ---| --- |
23 +| Content-Type | String | * | `"application/json"` |
24 +| Authorization | String | * | JWT Token |
25 +| X-Request-Id | String | | X-Request-Id for api flow tracing |
26 +
27 +#### QUERY STRING
28 +
29 +| Level | Name | Type/Len | Required(*) | Nullable(*) | Desc |
30 +| ---| ---| ---| ---| ---| --- |
31 +| 1 | page | Integer | | * | 頁籤 DEFAULT = 1 |
32 +| 1 | per_page | Integer | | * | 筆數/頁 DEFAULT = 20 |
33 +| 1 | audit__id | Integer | | | 審核 ID |
34 +| 1 | audit__progress | Enum | | | 審核進度:<br>pending: 待審核<br>approved: 已通過<br>rejected: 已拒絕 |
35 +| 1 | audit__action | Enum | | | 審核動作:<br>create: 新增<br>update: 更新<br>delete: 刪除 |
36 +| 1 | audit__requester_id | Integer | | | 申請人 ID |
37 +| 1 | award_group__id | Integer | | | 派獎群組 ID |
38 +| 1 | award_group__name | String | | | 派獎群組名稱 |
39 +| 1 | award_group__start_time | Datetime | | | 派獎開始時間 |
40 +| 1 | award_group__end_time | Datetime | | | 派獎結束時間 |
41 +| 1 | award_group__time_state | Enum | | | 時間狀態:<br>PROGRESS: 進行中<br>PENDING 未開始<br>FINISHED: 已結束 |
42 +| 1 | award_group__status | List(Enum) | | | 派獎群組狀態:<br>ACTIVE: 上架<br>INACTIVE: 下架<br>RETIRED: 永久下架 |
43 +| 1 | award_gp__action_code | String | | | 小樹點行動代碼 |
44 +
45 +### RESPONSE
46 +#### STATUS CODE
47 +* 200
48 +
49 +#### BODY
50 +
51 +| Level | Name | Type/Len | Nullable(*) | Desc |
52 +| ---| ---| ---| ---| --- |
53 +| 1 | status | String | | 回應狀態 (SUCCESS, FAILURE) |
54 +| 1 | data | Dict | | 通用資料包裝 |
55 +
56 +#### Data
57 +
58 +| Level | Name | Type/Len | Nullable(*) | Desc |
59 +| ---| ---| ---| ---| --- |
60 +| 2 | items | List | | 審核結果列表 |
61 +| 2 | pagination | Dict | | 分頁資訊 |
62 +
63 +#### Items (List Item)
64 +
65 +| Level | Name | Type/Len | Nullable(*) | Desc |
66 +| ---| ---| ---| ---| --- |
67 +| 3 | id | Integer | | 審核 ID |
68 +| 3 | feature | String | | 功能模組 |
69 +| 3 | function | String | | 功能名稱 |
70 +| 3 | progress | Enum | | 審核進度:<br>pending: 待審核<br>approved: 已通過<br>rejected: 已拒絕 |
71 +| 3 | comment | String | * | 審核備註 |
72 +| 3 | requester_id | Integer | | 申請人 ID |
73 +| 3 | auditor_id | Integer | * | 審核人 ID |
74 +| 3 | action | Enum | | 審核動作:<br>create: 新增<br>update: 更新<br>delete: 刪除 |
75 +| 3 | create_time | Datetime | | 建立時間 |
76 +| 3 | update_time | Datetime | | 更新時間 |
77 +| 3 | requester | Dict | | 申請人資訊 |
78 +| 3 | auditor | Dict | * | 審核人資訊 |
79 +| 3 | data | Dict | | 派獎設定資料 |
80 +
81 +#### requester / auditor
82 +
83 +| Level | Name | Type/Len | Nullable(*) | Desc |
84 +| ---| ---| ---| ---| --- |
85 +| 4 | id | Integer | | 使用者 ID |
86 +| 4 | username | String | | 使用者名稱 |
87 +
88 +#### data
89 +
90 +| Level | Name | Type/Len | Nullable(*) | Desc |
91 +| ---| ---| ---| ---| --- |
92 +| 4 | award_group | Dict | | 派獎群組資訊 |
93 +| 4 | awards | List(Dict) | | 獎項設定列表 |
94 +
95 +#### award_group
96 +
97 +| Level | Name | Type/Len | Nullable(*) | Desc |
98 +| ---| ---| ---| ---| --- |
99 +| 5 | action | Enum | | 動作:<br>create: 新增<br>update: 更新<br>delete: 刪除<br>filter: 顯示 |
100 +| 5 | data | dict | | |
101 +| 6 | id | Integer | | 派獎群組 ID |
102 +| 6 | name | String | | 派獎群組名稱 |
103 +| 6 | status | Enum | | 狀態:<br>ACTIVE: 上架<br>INACTIVE: 下架<br>RETIRED: 永久下架 |
104 +| 6 | time_state | Enum | | 時間狀態:<br>PENDING: 尚未開始<br>PROGRESS: 進行中<br>FINISHED: 已結束 |
105 +| 6 | start_time | Datetime | | 派獎開始時間 |
106 +| 6 | end_time | Datetime | | 派獎結束時間 |
107 +| 6 | create_time | Datetime | | 建立時間 |
108 +| 6 | update_time | Datetime | | 更新時間 |
109 +
110 +#### awards (List Item)
111 +
112 +| Level | Name | Type/Len | Nullable(*) | Desc |
113 +| ---| ---| ---| ---| --- |
114 +| 5 | award | Dict | | 獎項資訊 (含 action 和 data) |
115 +| 5 | prize_gp | Dict | | 小樹點獎項資訊 (含 action 和 data) |
116 +| 5 | notify | Dict | * | 推播通知資訊 (含 action 和 data) |
117 +
118 +#### award
119 +
120 +| Level | Name | Type/Len | Nullable(*) | Desc |
121 +| ---| ---| ---| ---| --- |
122 +| 6 | action | Enum | | 動作:<br>create: 新增<br>update: 更新<br>delete: 刪除<br>filter: 顯示 |
123 +| 6 | data | Dict | | |
124 +| 7 | id | Integer | | 獎項 ID |
125 +| 7 | code | String | | 獎項代碼 |
126 +| 7 | name | String | | 獎項名稱 |
127 +| 7 | group_id | Integer | | 所屬派獎群組 ID |
128 +| 7 | active_status | Enum | | 啟用狀態:<br>ACTIVE: 啟用<br>INACTIVE: 停用 |
129 +| 7 | process_status | Enum | | 處理狀態:<br>AVAILABLE: 可用<br>FULL: 已額滿<br>EXECUTED: 已執行 |
130 +| 7 | award_type | Enum | | 獎項類型:<br>ORCA_POINT: 小樹點<br>QWARE: Qware 點數<br>SELFGEN_VOUCHER: 自建票券<br>EDENRED: Edenred<br>SYSTEX: Systex |
131 +| 7 | deliver_type | Enum | | 發放類型:<br>IMMEDIATE: 立即發放<br>ETA: 預定時間發放 |
132 +| 7 | deliver_amount | Integer | | 發放數量 |
133 +| 7 | deliver_limit | Integer | | 發放上限 |
134 +| 7 | deliver_time | Datetime | * | 預定發放時間 |
135 +| 7 | create_time | Datetime | | 建立時間 |
136 +| 7 | update_time | Datetime | | 更新時間 |
137 +
138 +#### prize_gp
139 +
140 +| Level | Name | Type/Len | Nullable(*) | Desc |
141 +| ---| ---| ---| ---| --- |
142 +| 6 | action | Enum | | 動作:<br>create: 新增<br>update: 更新<br>delete: 刪除<br>filter: 顯示 |
143 +| 6 | data | Dict | | |
144 +| 7 | id | Integer | | 小樹點獎項 ID |
145 +| 7 | award_id | Integer | | 關聯獎項 ID |
146 +| 7 | action_code | String | | 行動代碼 |
147 +| 7 | expire_duration | Integer | | 過期天數 |
148 +| 7 | note | String | * | 備註 |
149 +| 7 | create_time | Datetime | | 建立時間 |
150 +| 7 | update_time | Datetime | | 更新時間 |
151 +
152 +#### notify
153 +
154 +| Level | Name | Type/Len | Nullable(*) | Desc |
155 +| ---| ---| ---| ---| --- |
156 +| 6 | action | Enum | | 動作:<br>create: 新增<br>update: 更新<br>delete: 刪除<br>filter: 顯示 |
157 +| 6 | data | Dict | | |
158 +| 7 | id | Integer | | 推播關聯 ID |
159 +| 7 | relation_table | Enum | | 關聯表:<br>AWARD: 獎項<br>ASSIGNED_COUPON: 塞券 |
160 +| 7 | relation_id | Integer | | 關聯 ID |
161 +| 7 | notification | Dict | * | 外部推播設定 (含 action 和 data) |
162 +| 7 | message | Dict | * | 訊息夾設定 (含 action 和 data) |
163 +
164 +#### notification
165 +
166 +| Level | Name | Type/Len | Nullable(*) | Desc |
167 +| ---| ---| ---| ---| --- |
168 +| 8 | action | Enum | | 動作:<br>create: 新增<br>update: 更新<br>delete: 刪除<br>filter: 顯示 |
169 +| 8 | data | Dict | | |
170 +| 9 | id | Integer | | 推播 ID |
171 +| 9 | pushnotify_relation_id | Integer | | 關聯 PUSHNOTIFY_RELATION.ID |
172 +| 9 | title | String | * | 推播標題 |
173 +| 9 | content | String | * | 推播內文 |
174 +| 9 | notification_behavior | Enum | * | 推播點擊行為:<br>OPEN_URL: 開啟連結<br>OPEN_INBOX: 開啟訊息夾 |
175 +| 9 | url | String | * | DeepLink 網址 |
176 +| 9 | create_time | Datetime | | 建立時間 |
177 +| 9 | update_time | Datetime | | 更新時間 |
178 +
179 +#### message
180 +
181 +| Level | Name | Type/Len | Nullable(*) | Desc |
182 +| ---| ---| ---| ---| --- |
183 +| 8 | action | Enum | | 動作:<br>create: 新增<br>update: 更新<br>delete: 刪除<br>filter: 顯示 |
184 +| 8 | data | Dict | | |
185 +| 9 | id | Integer | | 訊息夾 ID |
186 +| 9 | pushnotify_relation_id | Integer | | 關聯 PUSHNOTIFY_RELATION.ID |
187 +| 9 | title | String | * | 訊息夾標題 |
188 +| 9 | content | String | * | 訊息夾內文 |
189 +| 9 | btn_wording | String | * | 按鈕文字 |
190 +| 9 | url | String | * | 網址 |
191 +| 9 | create_time | Datetime | | 建立時間 |
192 +| 9 | update_time | Datetime | | 更新時間 |
193 +
194 +#### ERROR CODE
195 +
196 +| HTTP Status | ErrorCode | Message | Desc |
197 +| ---| ---| ---| --- |
Prev
派獎 - 審核覆核
Next
派獎 - 更新審核編輯