|
|
|
|
|
|
|
# Doc
|
|
|
|
|
|
|
|
## <span class="" style="color:blue;">GET</span> /doc/info
|
|
|
|
### Description
|
|
|
|
根據使用者權限獲取文件資訊
|
|
|
|
|
|
|
|
|
|
|
|
### Parameter
|
|
|
|
|
|
|
|
| Parameter | Description | Example | Parameter Type | Data Type |
|
|
|
|
| ----------|---------------| -------| -----| ------|
|
|
|
|
| docName | doc name，doc 的唯一名 | Guides\_and\_API\_References | query | string |
|
|
|
|
| lang | 語言key，或沒有指定則回傳英文文件菜單 | 1 | query | int |
|
|
|
|
|
|
|
|
### Response Body
|
|
|
|
|
|
|
|
``` javascript
|
|
|
|
{
|
|
|
|
"status": "success",
|
|
|
|
"list": [
|
|
|
|
{
|
|
|
|
"id": 1,
|
|
|
|
"version": "v1.0.2",
|
|
|
|
"status": 1,
|
|
|
|
"lastUpdatedByUser": "Yuying.lo@advantech.com.tw",
|
|
|
|
"lastUpdatedByRole": 2,
|
|
|
|
"lastUpdatedTime": "2019-05-09T10:41:46.167285+08:00",
|
|
|
|
"feedback": {
|
|
|
|
"yes": 3,
|
|
|
|
"no": 1
|
|
|
|
}
|
|
|
|
},
|
|
|
|
{
|
|
|
|
"id": 3,
|
|
|
|
"version": "v1.0.3",
|
|
|
|
"status": 2,
|
|
|
|
"lastUpdatedByUser": "Yuying.lo@advantech.com.tw",
|
|
|
|
"lastUpdatedByRole": 1,
|
|
|
|
"lastUpdatedTime": "2019-05-09T10:41:46.167285+08:00",
|
|
|
|
"feedback": {
|
|
|
|
"yes": 3,
|
|
|
|
"no": 1
|
|
|
|
}
|
|
|
|
},
|
|
|
|
],
|
|
|
|
"lang": 1
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
##### Field
|
|
|
|
| Field Name | Description | Example | Data Type |
|
|
|
|
| -----------|---------------| -------| -------|
|
|
|
|
| status | 成功或失敗 | success | string |
|
|
|
|
| message | 失敗訊息 | Doc name does not exist | string |
|
|
|
|
| list | list 物件陣列 | 如上範例 | array |
|
|
|
|
| list[x].id | 文件 id | 1 | int |
|
|
|
|
| list[x].version | 文件版本號 | v1.0.3 | string |
|
|
|
|
| list[x].status | 文件版狀態 | 2 | int |
|
|
|
|
| list[x].lastUpdatedByUsername | 最後更新使用者 username | Yuying.lo@advantech.com.tw | string |
|
|
|
|
| list[x].lastUpdatedByRole | 最後更新使用者角色 | 2 | int |
|
|
|
|
| list[x].lastUpdatedByTime | 最後更新時間 | 2019-05-09T10:41:46.167285+08:00 | string |
|
|
|
|
| list[x].feedback | 文件 feedback 物件 | {} | object |
|
|
|
|
| list[x].feedback.yes | 文件 feedback yes 數 | 2 | int |
|
|
|
|
| list[x].feedback.no| 文件 feedback no 數 | 2 | int |
|
|
|
|
| lang | 此 menu 的語言 | 1 | int | |
