大量操作

大量操作 API 設計用來在單一請求中對表單中的多筆資料執行相同的操作。

有兩種指定要更新資料的方法：

• 使用 where篩選

https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/<大量操作類型>?api&where=<欄位 ID>,<過濾操作元>,<值>

• 在查詢欄位中使用 recordId，例如 recordId=1&recordId=2

https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/<大量操作類型>?api&recordId=<資料 ID>

請求格式

• 大量操作 API 是非同步操作。
• 根據您的 Ragic 資料庫帳號 URL，需要將 API URL 中的 www 修改為 na3、ap5 或 eu2。

HTTP 方法 - POST
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/<大量操作類型>?api
標頭
Authorization: Basic 

主體
{
// 描述要執行操作的 JSON 資料
}

==========

回應
{
"taskId": <識別任務的 UUID>
}

大量鎖定

大量鎖定 API 允許一次鎖定或解鎖多筆資料。 大量鎖定

HTTP 方法 - POST
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/massLock?api

{
    "action": 
}

==========

回應
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

批次簽核

批次簽核 API 允許一次同意或拒絕多筆資料的簽核。 批次簽核

HTTP 方法 - POST
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/massApproval?api

{
    "action": , 
    "comment": <回應> // 可選
}

==========

回應
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

批次執行動作按鈕

批次執行動作按鈕 API 允許一次執行多筆資料的按鈕。 批次執行動作按鈕

HTTP 方法 - POST
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/massActionButton?api
{
"buttonId": <按鈕 ID>
}

==========

回應
{
"taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

取得表單中可用的動作按鈕列表

HTTP 方法 - GET
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/metadata/actionButton?api&category=massOperation

==========

回應
{
    "actionButtons": [
        {
            "id": <按鈕 ID 1>,
            "name": <按鈕名稱 1>
        },
        .....
        ,{
            "id": <按鈕 ID 2>,
            "name": <按鈕名稱 2>
        }
    ]
}

大量修改

大量修改 API 允許一次更新多筆資料的欄位值。

大量修改

HTTP 方法 - POST
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/massUpdate?api

{
    "action": [
        {
            "field": <欄位 ID>,
            "value": <新欄位值>
        }
    ]
}

==========

回應
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}

大量修改API也支持對 內部使用者表單 與 外部使用者表單 進行修改，但使用上有一些限制。

以下欄位不開放大量修改：

• 電子郵件(domainId: 1)
• 使用者名稱(domainId: 4)
• 系統備註(domainId: 10)
• 狀態(domainId: 31)
• 內外部(domainId: 43)

群組(domainId: 3) 開放修改，但有限制：

• value 的值必須為 JSON 陣列，其中包含字串元素。
• 字串中的特殊字元需要使用跳脫字符（\）來表示，特別是雙引號（“）需要表示為 \”

HTTP 方法 - POST
URL - https://www.ragic.com/<帳號>/<頁籤路徑參數>/<表單路徑參數>/massOperation/massUpdate?api

{
    "action": [
        {
            "field": 3,
            "value": "[\"SYSAdmin\"]"
        }
    ]
}

==========

回應
{
    "taskId": "6dbc796a-07d5-475b-b578-d254eb30f7d2"
}
    

• 內部使用者表單，必須至少有一個使用者的群組為 SYSAdmin
• 外部使用者表單，使用者的群組必須以 x- 或 X- 開頭

工作項目追蹤

大量操作是非同步的。操作的工作項目 ID 可用於監控其進度。

HTTP 方法 - GET
URL - https://www.ragic.com/<帳號>?api&taskId=<工作項目 ID>

==========

回應
{
    "id": <工作項目 ID>,
    "ap": <帳號>,
    "taskName": <工作項目名稱>,
    "status": <狀態>
}