匯出 Export API 容許您從表/檢視/報告匯出快照，並將它們儲存為伺服器上的物理檔案，以便以後檢索。
要使用匯出 Export API，您必須首先設定匯出日誌表以追蹤匯出的檔案。
要設定匯出日誌表，請轉至 PHP 設定 -> 頁面選項（全局） -> 匯出 部分，點選 建立表 旁邊的 匯出日誌表 按鈕。
對話框 “建立匯出日誌表” 將出現 ，點選“確定” 以建立匯出日誌表。
如果您已經有自己的表來存儲匯出日誌資料，則可以 選取您的匯出日誌表 在下拉清單中 ，然後點選[…] 按鈕設定以下欄位的欄位名稱。
| 檔案 ID (GUID) | 匯出檔案的檔案 ID。 主鍵欄位必須是唯一的。 |
| 日期時間 （日期時間） | 檔案匯出的日期及時間 |
| 使用者 （VarChar） | 請求匯出的使用者 |
| 匯出類型 （VarChar） | 匯出型。 可能的值：“excel”、“word”、“pdf”、“html”、“csv”、“xml”和“json”（無引號） |
| 表 (VarChar) | 匯出表/報告名稱 |
| 鍵值 (VarChar) | 匯出記錄的鍵值（可選）。 如果指定，則僅匯出特定記錄。 否則，表格/報告將相應地匯出為匯出類型（即“所有頁面”或“現用的頁面”）。 |
| 檔名 （VarChar） | 匯出檔名 |
| 請求 （文字） | 匯出請求 URL |
所有匯出 API 操作都將記錄在匯出日誌表中。 對於指定了“檔名”和“儲存”參數的匯出 API 請求，匯出的檔案將被儲存，您可以稍後使用匯出 API 檢索該檔案。
要測試匯出 API，您可以啟用 進階設定 -> 使用 Swagger UI 中生成的 swagger UI 並使用http://mysite/basepath/swagger/ 。
匯出 API 支援以下操作：
1. 匯出
將頁面匯出為特殊的檔案類型。
GET /api/export/{類型}/{表}
參數
| 類型 （字串） | 匯出類型（excel/word/pdf/html/csv/xml/json） |
| 表 （字串） | 表/報告名稱 |
| 鍵 （字串） | 錄音鍵（可選） |
| 頁 （整數） | 頁碼（可選） |
| 記錄頁 （完整） | 每頁記錄（可選） |
| 檔名 （字串） | 匯出檔名（可選） |
| 儲存 （整數） | 是否在伺服器上儲存檔案（1 = true，0 = false）如果為 true，則匯出的檔案將儲存在伺服器的匯出資料夾中。 如果為 false，則直接輸出檔案。 |
| 輸出 （整數） | 是否輸出檔案(1 = true, 0 = false)您可以選取儲存檔案但不輸出檔案（即 save=1&output=0 ）。 在這種情況下，只會返回一個檔案 ID 供以後使用。 請注意，如果 save 設定為 false， 則輸出 始終為 true。 |
例如，要將資料從“orders”表匯出到 Excel，您可以運行此匯出 API 請求：
如果啟用save=1，則運行請求後，匯出的檔案將儲存在伺服器上。 如果output=1（或未指定），則直接輸出檔案。 如果output=0，您將從API響應中取得檔案ID，稍後可以使用該ID下載匯出的檔案。
2.通過ID取得
通過檔案 ID 取得先前匯出（和儲存）的檔案（例如，從“搜尋”操作，見下文）。
取得 /api/export/{id}
參數
| id （字串） | 匯出檔案id以檢索匯出的檔案 |
| 檔名 （字串） | 覆蓋匯出的檔名（可選）。 如果未指定，將使用原始匯出的檔名。 |
例如，要檢索具有已知檔案 ID 的檔案：
3. 搜尋並下載
搜尋匯出日誌並下載檔案（或取得檔案 ID 清單）。
GET /api/匯出/搜尋
參數
| 限制 （整數） | 最新匯出的檔案（例如limit=10表示最新匯出的10個檔案） |
| 類型 （字串） | 匯出類型（excel/word/pdf/html/csv/xml/json） |
| 表名 （字串） | 表/報告名稱 |
| 檔名 （字串） | 匯出檔名 |
| 日期時間 （字串） | 約會時間 |
| 輸出 （整數） | 是否輸出檔案(1 = true, 0 = false)您可以選取輸出檔案或僅取得檔案 ID。 如果未指定，則預設為 true。 |
例如，要搜尋最後匯出的檔案，請指定 limit=1：
筆記：
- 如果搜尋後有多個檔案，則輸出將為匯出檔案的壓縮檔。
- Zip 需要 PHP Zip 擴展 。 如果未啟用擴展，則將輸出檔案 ID，而不是壓縮檔。
重要筆記
- 對於表/檢視，支援的匯出類型為“excel”、“word”、“pdf”、“html”、“csv”、“xml”和“json”。 對於報告，支援的匯出類型僅內含“excel”、“word”、“pdf”和“html”。
- 自訂模板 匯出 API 不支援 。 具有自訂模板的表格/報告無法儲存為外部檔案。
- 匯出的檔案儲存在匯出資料夾中（在上傳資料夾下）。 預設資料夾名稱為 “export-<項目 ID>” 中變更它 ，您可以在進階設定 -> 匯出資料夾 。
- 為了避免 JWT 過期並保護您的站台，在使用匯出 API 時，您可以指定更長的過期時間，但僅在從登入 API 取得 JWT 時才具有匯出 權限 。 請參閱 中的過期 和 權限 參數 登入 API 以了解更多詳細訊息。 例如，要取得僅具有匯出權限的 24 小時 JWT，請將 過期 設定為 24， 權限 設定為 1024。
有關 Swagger UI 的更多訊息，請參閱 使用 Swagger UI 進行 API 。
有關匯出 API 的更多詳細訊息，請閱讀 REST API 。