查詢流程日誌 API - Jodoo

簡介

API 簡介

該 API 用來查詢流程日誌資訊，目前僅支援返回包含簽核意見的流程日誌。

API 版本

API 版本	更新時間	API 說明
V1	2024.01.26	原始 API

API 調用

該 API 用來查詢流程日誌資訊。

請求地址：https://api.jodoo.com/api/v1/workflow/instance/logs

請求頻率：30 次/秒

請求方式：POST

請求參數:

參數	必須	類型	說明
instance_id	是	string	實例 ID，同 data_id
types	是	string[]	返回的日誌類型，可選項；簽核意見：“comment”
limit	否	number	分頁參數頁大小預設 100 ，最大 100
skip	否	number	分頁參數，跳過前面資料條數預設為 0

請求範例：

{
    "instance_id": "659cba93489a49c06f7d4281",
    "types": [
        "comment"
    ],
    "skip": 0,
    "limit": 10
}

回應參數：

參數	類型	說明
logs	object[]	日誌列表
logs[].flow_id	number	節點 ID
logs[].flow_name	string	節點名稱
logs[].create_action	string	建立待辦的流程動作
logs[].create_time	Date	待辦開始時間
logs[].finish_action	string	完成待辦的流程動作
logs[].finish_time	Date	待辦完成時間
logs[].comment	string	簽核意見內容
logs[].signature	object	簽核意見手寫簽名
logs[].signature.url	string	簽核意見手寫簽名 URL，6 天有效期
logs[].attachments	object[]	附件列表
logs[].attachments[].name	string	附件文件名
logs[].attachments[].size	number	附件文件大小
logs[].attachments[].mime	string	附件文件類型
logs[].attachments[].url	string	附件文件 URL，6 天有效期
logs[].operator	object	簽核/操作人資訊，同成員實體結構

回應範例：

{
    "logs": [
        {
            "flow_id": 1,
            "flow_name": "必須手寫簽名",
            "create_time": "2024-01-09T03:16:35.447Z",
            "create_action": "forward",
            "finish_time": "2024-01-09T03:17:03.239Z",
            "finish_action": "forward",
            "operator": {
                "username": "Jodoo",
                "name": "Jodoo",
                "departments": [
                    1
                ],
                "type": 0,
                "status": 1
            },
            "comment": "一條簽核意見",
            "signature": {
                "url": "https://files.jodoo.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
            },
            "attachments": [
                {
                    "name": "IMG21.jpeg",
                    "size": 74935,
                    "mime": "image/jpeg",
                    "url": "https://files.jodoo.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
                },
                {
                    "name": "6b2cc009-141d-44c4-b5fc-5d01667ee0f8.jpg",
                    "size": 33174,
                    "mime": "image/jpeg",
                    "url": "https://files.jodoo.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
                },
                {
                    "name": "24x24.png",
                    "size": 34281,
                    "mime": "image/png",
                    "url": "https://files.jodoo.com/FtMNaGofTPeLMFW5_5SCs8w2mX8h?e=1595347199&token=bM7UwVPyBBdPaleBZt21SWKzMylqPUpn-05jZlas:iac5fKQqYDZkF1YyvJUm4YRDPzg="
                }
            ]
        }
    ]
}

查詢流程日誌 API調試

簡介

API 簡介

API 版本

API 調用