全量匯入部門 API調試

簡介

API 簡介

本 API 以 dept_no(部門編號)為主鍵,全量覆蓋企業內的通訊錄部門樹。

API 調用

本 API 以 dept_no(部門編號)為主鍵,全量覆蓋企業內的通訊錄部門樹。

API 地址https://api.jodoo.com/api/v5/corp/department/import

請求頻率:10 次/秒

請求方式:POST

注意事項

1. 部門編號為數字類型且唯一。

2. 除了根部門以外所有部門的父部門必須存在。如果新匯入列表中不存在根部門, 則會自動插入根部門, 且部門名稱為企業名稱。

3. 同級部門名稱不能有重複。

4. 部門層級不能超過 16 級。

5. 如果匯入資料存在,且現有企業通訊錄中也存在,則更新該部門的資訊。

6. 如果匯入資料存在,而現有企業通訊錄中不存在,則新建該部門。

7. 如果匯入資料不存在,但現有企業通訊錄中存在,則繼續判斷該部門下是否存在子部門和成員,如果都沒有則自動刪除該部門,否則將子部門和成員轉移到根部門下繼續保留。

8. 該 API 允許匯入的部門數上限為 100,000。

9. 該 API 調用執行期間,將無法同時調用其他對通訊錄的修改、刪除、新增 API。

請求參數

參數

是否必需

類型

說明

departments

Array

部門列表

departments[].dept_no

Number

部門編號(上限 9007199254740991)

departments[].name

String

部門名稱

departments[].parent_no

Number

父部門編號,不傳預設為根部門下

請求範例

{
    "departments": [{
        "dept_no": 11,
        "name": "研發部門",
        "parent_no": 1
    }, {
     "dept_no": 12,
     "name": "測試部門",
     "parent_no": 1
    }]
}

附註

在使用批次匯入部門的 API 時,在傳入新部門的同時,還需要寫入新部門的根部門,以保證部門樹結構的完整性。

例如,想在 SSO_dept 這個部門下插入一個新的子部門,如果只傳新部門的話,會報錯父部門不存在。例如,想在 SSO_dept 這個部門下插入一個新的子部門,如果只傳新部門的話,會報錯父部門不存在。

此時需要把 SSO_dept 部門也傳一下,即使該部門已經存在了,但為了樹結構的完整性以及新部門的準確插入,需要再次寫入。

最終效果如下:

回應內容

參數

類型

說明

status

String

返回請求結果

回應範例

{
    "status": "success"
}

這項資訊有幫助嗎?
需要更多協助嗎?聯繋技術支援。